shadcn.io is not affiliated with official shadcn/ui
Guided Walkthrough Onboarding Block for React
A learn-by-doing walkthrough in a framed window: a drawn design-review app beside a docked guide of four tasks, where the control for the current task is ringed and doing it, by click or by key, opens the next.
Installation
Overview
Teach a product by letting people use it, with this walkthrough for React with Base UI. It is a window of Lanternfell, a design-review canvas: the app is drawn at two thirds of a framed window (a top bar with Share, a row of tools with search, add and comment, a canvas with a frame, and a properties panel), and a docked guide holds the other third with four tasks, a count with a hairline of Progress, and the one you are on. The control for the current task is ringed in the drawing, and the ring draws in three times and then rests. Doing it, by pressing the control or its key shown in Kbd, ticks the task, makes the drawing react (a search list opens, a second frame appears, a comment pin lands, the file reads Shared) and opens the next one. Skip this step moves on without it. On a phone the drawing sits above the guide.
FAQ
How is it different from a tour?
A tour points at things and moves on when you press Next; this waits. Each task is complete only when you do it: press the ringed control or the key, and the drawing changes as the real app would. The other controls stay where they are and, when pressed out of order, say what to do first. Skip this step is there for anyone who knows it already.
Where do the keys work?
Only while focus is somewhere inside the window: a capture listener on the window's own element hears them, so nothing is bound to the page and your site's own shortcuts are untouched. The status line says so. Command shows first and becomes Ctrl after the page loads on a system that has no Command key; the Share task uses it.
What stays local in the demo, and how do I wire it?
All of it. Nothing is shared, commented or saved; the drawing is a picture that reacts, and each result is said in a polite status line (“Done: Open search. Next: Add a frame.”). In your app, drop the drawing, point each task's id at a real control in your UI, and mark the task done from the real event, for example when your search opens.
What about reduced motion?
The ring is the cue, not the motion: it is always drawn round the current control, and the three-times draw-in plays only when motion is allowed. Nothing loops, and nothing else in the window moves by itself.
How do I change the four tasks?
Edit TASKS: each has a title, one sentence on what to do, and the key. A task's control is one of the Target buttons in the drawing, matched by id; to add a fifth, add a control to the drawing and a line to TASKS. Keep the list short: a walkthrough longer than four or five tasks is a course.
Related
- Pro
Product Tour Onboarding
Welcome and toursA four-stop product tour over a drawn analytics dashboard: a coachmark points at the metrics, the segments, the report and the settings one at a time, with the part lit and the rest dimmed, and a Replay tour button that starts the real Tour.
- 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
Practice Keyboard Shortcuts Onboarding
Welcome and toursA code review tool's shortcut sheet you can practise on: a table of six shortcuts that tick off as you press them while focus is inside the panel, a chord with a waiting state, and a Command or Ctrl switch.
- Pro
Setup Checklist Onboarding
ChecklistsA 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.
- Pro
Help Sheet Onboarding
Welcome and toursA support inbox's help sheet from the end edge: a search that filters eight articles as you type with the matches marked, the four ways to reach support as real links, and an empty state that offers Clear search.
- Pro
Email Client Sidebar
App contentA mail client in a fixed-height window: mailboxes and labels whose counts follow the mail you file, a searchable message list beside the open message, and Compose for a local draft.