Interactive guides are in-app, step-by-step tours that highlight key UI elements and explain workflows. They complement the video tutorials by giving users a hands-on walkthrough.
How It Works#
- Guides are defined as structured steps with titles, content, and target selectors.
- The
GuideProvidermanages state and exposesstartGuideand navigation actions. GuideOverlayrenders the tooltip, spotlight, and progress UI.
Step Types#
modal: Centered step without a target element.tooltip: Anchored tooltip with a highlight ring on the target.highlight: Spotlight cutout that dims everything except the target.
Default Guide: Welcome Tour#
Location: apps/web/src/lib/guides.ts
Selectors used:
[data-tour="dashboard-main"](Welcome page container)[data-tour="main-nav"](Header navigation)[data-tour="create-button"](New Project button)[data-tour="user-menu"](Profile menu)
Adding a New Guide#
- Define a new guide in
apps/web/src/lib/guides.ts. - Add the guide to
APP_GUIDES. - Add
data-tourattributes to the target components. - Trigger the guide with
useGuide().startGuide('guide-id').
Accessibility Notes#
- Keyboard shortcuts:
Escto exit,Enter/Right Arrowto advance,Left Arrowto go back. - The overlay uses
role="dialog"andaria-modal="true".