Guide layout
Responsive two-column onboarding layout beside page content when expanded, collapsing cleanly above content on narrow screens.
Interactive example
Loading Polaris web components…
Usage
<GuideLayout collapsed={collapsed} panel={<SetupGuide steps={steps} collapsed={collapsed} onCollapsedChange={setCollapsed} />}>{content}</GuideLayout>Properties
| Property | Type | Default | Description |
|---|---|---|---|
| panel | ReactNode | Required | SetupGuide or host guide. |
| children | ReactNode | Required | Page content. |
| collapsed / dismissed | boolean | false | Controlled placement and visibility. |
Design & interaction
Completion and preference persistence belong to the host. Expanded desktop layout uses a left guide; narrow screens stack. Main content must have min-width zero.
Accessibility
Document order stays guide then content; native buttons keep focus and expanded state.
Open-source source
Available in github.com/Kaupvik/kaupvik-polaris ↗. Host apps supply authentication, native persistence, and read-back state.