Onboarding checklistPro
Guide a new workspace through setup: a ring and count, one open step with its action, checks that draw in, Hide / Show, and a done title once everything is complete.
oxyn add onboarding-checklistSet up your workspace
Approvals can route to anyone in the workspace.
The preview stays free for everyone. Pro opens the code of every Pro component, screen, agent-app template, block and kit, plus the Pro CLI.
Rendered from Rust at build time · goes live when visible
When to use
- Guide a new workspace through setup: a progress ring and “n of m done”, one open step at a time with what it is for and its action button, checks that draw in, the next open step opening after a check, Hide / Show for the body, and a done title once all are complete.
When not to use
- An agent asks before it acts: use Approval Card instead.
- Several open requests in one card: use Approval pager instead.
- An agent's question in its own card above the composer: use Decision Card instead.
Installation
Onboarding checklist is part of Oxyn Pro; the preview is free. Pro items install with the oxyn CLI once your licence is signed in; until then Pro members copy the code from this page.
oxyn add onboarding-checklistUsage
The preview is free. Pro opens the code of every Pro component, screen and template.
Examples
Progress
2 of 5 with the next one open.
Set up your workspace
Approvals can route to anyone in the workspace.
Code Pro
The preview is free. Pro opens the code of every Pro component, screen and template.
Fresh
Nothing done.
Set up your workspace
Helps your team recognise you in threads and approvals.
Code Pro
The preview is free. Pro opens the code of every Pro component, screen and template.
Done
You’re all set.
You’re all set
Code Pro
The preview is free. Pro opens the code of every Pro component, screen and template.
Hidden
Folded to its header.
Set up your workspace
Code Pro
The preview is free. Pro opens the code of every Pro component, screen and template.
API reference
OnboardingChecklist
| Prop | Type | Default | Description |
|---|---|---|---|
listrequired | Checklist | — | Model. |
title | String | "Set up your workspace" | Heading. |
done_title | String | "You’re all set" | Title once done. |
on_toggle | EventHandler<String> | — | Toggle an item done. |
on_open | EventHandler<String> | — | Open an item. |
on_hide | EventHandler<bool> | — | Hide / Show. |
Read from the Rust signature and doc comments.
Keyboard interactions
| Key | Action |
|---|---|
| Tab | Checkboxes, titles, actions, Hide |
| EnterorSpace | Toggle, open, run the action |
Accessibility
- Checkboxes are role=checkbox buttons named by the item.
- Hide/Show has aria-expanded.
From the spec
- Checkboxes are role=checkbox buttons; Hide has aria-expanded.
Motion & interaction
Timing
- Reduced motion: no entrance rise, no shimmer (static muted text), rings and bars jump to their value.
Responsive behaviour
- Max 480 px.
Edge cases (spec)
- Max 480 px.
Notes for AI
- Import
OnboardingChecklistfromoxyn_dioxusand includeSTATUS_INDICATOR_CSSplus the token stylesheet once. - A GPUI version exists:
ChecklistElinoxyn_gpui. - Props to set first:
list. - Keep its states and timings as they ship; restyle it through the CSS variables rather than by hand.