Tour
A product tour. A spotlight glides from one element to the next, stretching on springs, with a card beside it. Overlays.
Open playgroundInbox
Reports
Settings
About
Tour is a React component in the Overlays category of smoui. It is typed, ships no stylesheet, follows your theme through CSS variables, and honors prefers-reduced-motion. Import it with import { Tour } from "@ashutoshswamy/smoui" and set steps, trigger, open.
Install
npm i @ashutoshswamy/smouiUsage
import { Tour } from "@ashutoshswamy/smoui";
<Tour
trigger="Start tour"
steps={[
{ target: "#inbox", title: "Your inbox", body: "New messages land here first." },
{ target: "#reports", title: "Reports" },
]}
onFinish={() => markSeen()}
/>Props 3
- steps
`target` is a CSS selector. Each element is scrolled into view.
{ target: string; title: string; body?: string }[]- trigger / triggerClassName
Start button. Omit and use `open`.
ReactNode / string- open / onOpenChange / onFinish
Controlled mode and a callback for the last step.
boolean / fn / fn
More overlays components
- CommandPaletteCmd+K palette. Type to filter, arrows move one highlight that stretches between rows, Enter runs.
- ConfirmPopoverA small are-you-sure that opens beside its button instead of taking over the page. A failed action stays open and says so.
- ContextMenuRight-click, long-press or press the Menu key for a menu that opens out of the exact point you pressed. It flips to stay on screen and moves with the arrow keys.
- DialogA modal that grows out of its trigger, traps focus and keeps its header and footer in view while long content scrolls. Alert mode guards destructive decisions; the confirm button handles async work and failure itself.
- DropdownA menu with one highlight that stretches between rows. Arrow keys, Home and End move it, Enter picks, Escape closes.
- HoverCardA card that opens when you rest on a name, stays while you move onto it and closes when you leave.