shadcn.io is not affiliated with official shadcn/ui
Setup Checklist Onboarding Block for React
A contract tool's get-started guide as a setup panel: six steps in a single-open accordion with one button in the open step, a count that follows what you finish, a menu that hides completed steps or the guide, and a pill that opens it again.
Installation
Overview
Guide new customers through setup without leaving the app, with this checklist panel for React with Base UI. It is the docked "Get started" card of Parchhurst, a contract-signing tool: a header, then a framed panel with a count ("5 of 6 to do", rolling) and a hairline of progress over six steps in an Accordion that keeps exactly one step open. The open step shows its sentence and the panel's one Shine Button; finish it and the step reads Done with a tick, the next one opens, and the count drops by one. A done step can be put back. A Dropdown Menu over the panel hides the completed steps or the whole guide, which folds into a pill ("Setup guide, 4 to do") that brings it back. On a phone the same list runs full width. For SaaS activation, first-run checklists and any product with a short list of things to set up.
FAQ
How do I change the steps?
Edit STEPS: each has an id, a title, the sentence shown when it is open and the action label of its button. START_DONE and START_OPEN say what is done and which step is open on load. The count, the progress line, the Done and Next up words and the sentence under the list are all worked out from the list of done ids, never typed twice, so adding a seventh step needs nothing else. Keep the sentences about the same length: every open step is given the same height, so the panel never jumps between steps.
What happens when I press the button in an open step?
In the demo the step is marked Done and the next step that is not done opens, going round to the top if needed; focus moves to that step's header and a polite status line says what changed ("Marked done in this demo. 4 of 6 to do. Next up: Invite your team."). When the last step is done nothing opens, the line under the list reads "All six steps are done. You can hide this guide." (the foot always has a Hide guide button). A done step opens to a Mark as not done button instead.
How do hiding the guide and the completed steps work?
The menu has two items. Hide completed steps takes the done rows out of the list, keeps the panel at the same height and says how many are hidden. Hide guide replaces the whole panel with the pill, and focus goes to the pill; the pill (or Show guide in the menu) brings the guide back with the same step open. Nothing is remembered between visits in the demo: to remember it, save the two flags with the person's account.
What stays local in the demo, and how do I wire it?
Everything. Nothing is sent, created or invited: the buttons only change the ticks. In your app, make each button open the real place (the template editor, the invite dialog) and let done come from what your server knows the account has done, so a step ticks itself when the work is finished anywhere. Keep the hidden flags per person.
Can I use it from the keyboard?
Yes. Tab reaches the menu button, each step header and the open step's button; Enter or Space opens a step. The menu opens with Enter, Space or the arrow keys and closes with Escape, returning focus to its button. The arrow keys don't move between step headers on this base; Tab does.
How does it look on a phone?
The header's menu button drops under the sentence, and the panel keeps its single column: the count and progress line on top, the steps as full-width rows with the state word at the end, the open step's sentence wrapping to a few lines, and the foot line under the list. The open step's button is on the first screen.
Related
- Pro
Mission Tiles Onboarding
ChecklistsAn online-shop builder's launch checklist as four framed tiles in a two by two grid, each with a small drawing, a link to the job and a Mark done toggle, and a ring in the header that fills as you go.
- Pro
Setup Progress Onboarding
ChecklistsA teachers' app's setup progress as a whole screen: a big rolling percent over a bar, a line of steps done and minutes to go, one button that finishes the next step, and three foldable bands that list every step as Done, Next up or To do.
- Pro
Quick Actions Sandbox Onboarding
ChecklistsA document workspace's first four moves as a sandbox panel: four rows with Try and Undo buttons beside a small drawn workspace that adds a document, a teammate, a connected app and a reminder.
- Pro
A CRM's first-run checklist: a continuous progress ring and a headline that follows it at the start, four steps in an accordion in the frame (the first picks Sales, Support or Hiring and the rest follow it), and Complete setup, which stays quiet until all four are done.
- Pro
Getting Started Empty State
First runA getting-started card for an empty dashboard: four setup steps as real checkboxes, a headline that counts down with a progress bar, and a drawn trail up a hill with a flag that stands at the done count.
- Pro
Learning Track Picker Onboarding
One choiceA course library's first-run track picker as a whole screen: three tracks in a single-open accordion where the open row is the choice, its first lessons, and a line and a button worked out from the pick.