Toolmark

Appearance

toolmark-monorepo / @toolmark/tour / StartTourOptions

Interface: StartTourOptions ​

Defined in: packages/tour/src/types.ts:145

Options for startTour. Pass exactly one of steps or goal + planner.

Properties ​

goal? ​

optional goal?: string

Defined in: packages/tour/src/types.ts:151

Goal for the planner.

mode ​

mode: TourMode

Defined in: packages/tour/src/types.ts:147

The tour mode.

planner? ​

optional planner?: Planner

Defined in: packages/tour/src/types.ts:153

App-supplied planner for goal.

reducedMotion? ​

optional reducedMotion?: boolean

Defined in: packages/tour/src/types.ts:158

Skip the do-mode highlight sequence. Default: matchMedia('(prefers-reduced-motion: reduce)').matches.

signal? ​

optional signal?: AbortSignal

Defined in: packages/tour/src/types.ts:160

Aborting stops the tour (and is passed to the planner and to do calls).

steps? ​

optional steps?: TourStep[]

Defined in: packages/tour/src/types.ts:149

Authored steps.