Toolmark

Appearance

toolmark-monorepo / @toolmark/tour / TourEvent

Type Alias: TourEvent ​

TourEvent = { reason: string; step: TourStep; type: "step_invalid" | "anchor_missing" | "step_skipped"; } | { index: number; step: TourStep; type: "step_entered"; } | { type: "done"; }

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

Tour lifecycle events.

Union Members ​

Type Literal ​

{ reason: string; step: TourStep; type: "step_invalid" | "anchor_missing" | "step_skipped"; }

reason ​

reason: string

step ​

step: TourStep

type ​

type: "step_invalid" | "anchor_missing" | "step_skipped"

  • step_invalid — a planned step was dropped (reason unknown_tool, unknown_param or malformed_step).
  • anchor_missing — the step's element is not rendered; the step was skipped.
  • step_skipped — the step's tool disappeared mid-tour (reason tool_removed).

Type Literal ​

{ index: number; step: TourStep; type: "step_entered"; }

Type Literal ​

{ type: "done"; }