Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TourStep<>

A step in a Tour

Type Parameters

    Hierarchy

    • TourStep

    Index

    Properties

    Properties

    id

    id: string

    A machine-friendly id of the Tour Step

    title

    title: string

    The title of the step, displayed in the tooltip header

    content

    content: string

    Raw HTML content displayed during the step

    selector

    selector: string

    A DOM selector which denotes an element to highlight during this step. If omitted, the step is displayed in the center of the screen.

    tooltipDirection

    tooltipDirection: { UP: string; DOWN: string; LEFT: string; RIGHT: string; CENTER: string }

    How the tooltip for the step should be displayed relative to the target element. If omitted, the best direction will be attempted to be auto-selected.

    Type declaration

    • UP: string
    • DOWN: string
    • LEFT: string
    • RIGHT: string
    • CENTER: string

    restricted

    restricted: boolean

    Whether the Step is restricted to the GM only. Defaults to false.