Toolmark

Appearance

toolmark-monorepo / @toolmark/tour / TourStep

Interface: TourStep ​

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

One tour step. Steps reference tools and params, never CSS selectors (spec §11.5).

Example ​

ts
`{ tool: 'challenges.create.fill', param: 'type', text: 'Pick the challenge type' }`

Properties ​

input? ​

optional input?: unknown

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

do mode: the tool input. Form fills may pass the field values directly (wrapped as { values } when the tool's input schema has a values property); wizard fills pass { steps: … } unchanged. Omitted → {}.

param? ​

optional param?: string

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

Input path the step points at, e.g. type, items.0.qty, or <step>.<path> for wizards.

text ​

text: string

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

App-localized explanation shown for the step.

title? ​

optional title?: string

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

App-localized step title.

tool ​

tool: string

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

Full tool name, e.g. challenges.create.fill.

waitFor? ​

optional waitFor?: "input" | "submit"

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

guide mode: advance on a valid input (default) or on the user's submit.