Mixins / foldkit-mixins-ui

TourView

interface · packages/mixins-ui/src/tour.ts:271

interface TourView<ParentMessage> {
  readonly model: Model
  readonly config: Config
  readonly onMessage: (message: Message) => NoInfer<ParentMessage>
  readonly padding?: number | undefined
  readonly interactive?: boolean | undefined
  readonly dismissOnOutside?: boolean | undefined
  readonly closeOnEscape?: boolean | undefined
  readonly progressLabel?: ((step: number, count: number) => string) | undefined
  readonly labels?:
    | {
        readonly back?: string
        readonly next?: string
        readonly done?: string
        readonly skip?: string
      }
    | undefined
  readonly direction?: 'ltr' | 'rtl' | undefined
  readonly style?: NamedStyle<typeof TourSlots> | undefined
  readonly mixins?: MixinList<ParentMessage> | undefined
}

Members

TourView.model

property · packages/mixins-ui/src/tour.ts:272

readonly model: Model

TourView.config

property · packages/mixins-ui/src/tour.ts:274

readonly config: Config

The steps; the same as update's.

TourView.onMessage

property · packages/mixins-ui/src/tour.ts:275

readonly onMessage: (message: Message) => NoInfer<ParentMessage>

TourView.padding

property · packages/mixins-ui/src/tour.ts:277

readonly padding?: number | undefined

Pixels the cutout reaches past its target; default 8.

TourView.interactive

property · packages/mixins-ui/src/tour.ts:279

readonly interactive?: boolean | undefined

Whether the target can be used through the cutout; default true.

TourView.dismissOnOutside

property · packages/mixins-ui/src/tour.ts:281

readonly dismissOnOutside?: boolean | undefined

Whether a press on the dim skips the tour; default false, so a stray press keeps it.

TourView.closeOnEscape

property · packages/mixins-ui/src/tour.ts:283

readonly closeOnEscape?: boolean | undefined

Whether Escape skips the tour; default true.

TourView.progressLabel

property · packages/mixins-ui/src/tour.ts:285

readonly progressLabel?: ((step: number, count: number) => string) | undefined

How the step's place is told; default "2 of 5".

TourView.labels

property · packages/mixins-ui/src/tour.ts:287

readonly labels?:
  | {
      readonly back?: string
      readonly next?: string
      readonly done?: string
      readonly skip?: string
    }
  | undefined

The buttons' words; defaults Back, Next, Done on the last step, and Skip tour.

TourView.direction

property · packages/mixins-ui/src/tour.ts:296

readonly direction?: 'ltr' | 'rtl' | undefined

Default 'ltr'; under 'rtl' ArrowLeft goes on to the next step.

TourView.style

property · packages/mixins-ui/src/tour.ts:298

readonly style?: NamedStyle<typeof TourSlots> | undefined

A style of TourSlots, for the look.

TourView.mixins

property · packages/mixins-ui/src/tour.ts:300

readonly mixins?: MixinList<ParentMessage> | undefined

Mixins beside the style.