Skip to main content

walkthrough

function

Declare a guided set of onboarding steps the host presents. Declarative, like `theme`: no handler, no code path of yours runs. Each step carries its own copy and media, and marks itself done either when a named command runs or when one of its completion events fires, so the host tracks progress without the mod polling anything. This is for teaching a mod, one screen at a time. To put UI in front of the user on demand, use `view` or `widget` instead.

function walkthrough<TId extends string>(walkthroughValue: WalkthroughInput<TId>): Walkthrough<TId>

Import

import { walkthrough } from '@modular/sdk';

Notes

category
Authoring