ns-ui

Tour Spotlight

An onboarding tour rendered as a lighthouse — the current target gets a light ring and halo while the rest of the page drops to penumbra behind a single SVG-masked scrim, and advancing sweeps a feathered beam along the path from the old target to the new one as the hole morphs to match.

Use when a step-by-step onboarding tour where the path between targets should be visible, a beam sweeping from the old target to the new one as the mask hole morphs to match; pick shortcuts-cheat-sheet instead when the user is looking up keyboard bindings rather than being walked through the UI, or wizard-dovetail when the steps are a form the user fills in rather than a tour of things already on screen.

Install

npx shadcn add https://design.helpmarq.com/r/tour-spotlight.json
  • onboarding
  • tour
  • coach-mark
  • walkthrough
  • spotlight
  • svg-mask
  • overlay
  • accessibility

ns-ui / tour-spotlight

BasecampSaved
+ NewFilterSort
Invite teammateSend invite

A 4-stop tour auto-advances through the mini-app above; the beam sweeps between each highlighted control while the rest dims.

Step 1 of 4: Projects live here
1 of 4

Projects live here

Every workspace you have access to shows up in this nav — switch between them without leaving the page.

Props

PropTypeDefaultDescription
stepsLeadingLightStep[]
activenumbercurrent step index, 0-based
onNext() => void
onBack() => void
onExit() => voidEsc or Skip — caller unmounts / restores whatever it wants
className?string