Setup guide
Compact readiness checklist, with concise step status, primary action button, and collapsible detail rows.
Interactive example
Usage
<SetupGuide steps={steps} collapsed={collapsed} onCollapsedChange={setCollapsed} />Properties
| Property | Type | Default | Description |
|---|---|---|---|
| title | string | Setup guide | Guide heading. |
| steps | {id,title,detail,done,action}[] | Required | Host-verified completion and actions. |
| collapsed / onCollapsedChange | boolean / callback | false / Required | Controlled host preference. |
| busy | boolean | false | Host work in progress. |
| dismissed / onDismiss | boolean / callback | false / optional | Only hides completed checklists; the host owns local persistence. |
Design & interaction
Native checkbox steps, native Verified badges, one detail at a time. Close is available only after every step completes and asks for confirmation. Host owns progress and local preferences. Verified appears only inside the expanded step detail, never in its closed row.
Accessibility
Native button step toggles expose expanded state and controlled detail IDs. Text and icon communicate completion. Keyboard focus is visible; narrow text wraps without overflowing. Readonly checkbox labels stay accessible while visible titles retain normal contrast; Verified badges wrap below the title. Expanded completion is a native success badge.
Open-source source
Available in github.com/Kaupvik/kaupvik-polaris ↗. Host apps supply authentication, native persistence, and read-back state.