Can the tour target any element?

Yes. Each step's target is a CSS selector, and the spotlight measures and frames whatever it matches.

How do I install Tour Spotlight?

Tour Spotlight is part of Charcoal UI Pro. Add the @charcoal registry to components.json with your access token, then run npx shadcn@latest add @charcoal/tour-spotlight. It copies tour-spotlight.tsx into components/ui and installs motion, clsx, tailwind-merge.

Is Tour Spotlight free for commercial use?

Tour Spotlight needs a Charcoal UI Pro seat, monthly or a one-time lifetime price. A seat covers unlimited personal and commercial projects, including client work, and every future Pro component.

Does Tour Spotlight work with Next.js?

Yes. It is a client component for React 19 styled with Tailwind CSS 4, so it works in the Next.js App Router and Pages Router, Vite, Remix and Astro.

Can an AI coding agent install Tour Spotlight?

Yes. Connect the Charcoal UI MCP server (https://charcoalui.com/mcp) to Claude Code, Cursor or any MCP client; get_component returns Tour Spotlight's props and get_install_command returns the exact command.

Tour Spotlight

An onboarding tour that cuts a spotlight out of a dim overlay around the current target and morphs the hole and its card from step to step. Arrow keys and Enter advance, Escape ends.

Category: Overlays
Licence: Charcoal UI Pro
Built with: React 19, Tailwind CSS 4, Motion
Dependencies: motion, clsx, tailwind-merge

Examples

Tour Spotlight

API reference

Prop	Type	Default	Description
`steps`	`{ target: string; title: string; body: string }[]`	—	target is a CSS selector.
`open`	`boolean`	—
`onOpenChange`	`(open: boolean) => void`	—
`padding`	`number`	`8`
`radius`	`number`	`12`
`container`	`RefObject<HTMLElement>`	—	Scope the tour to an element instead of the page.
`onFinish`	`() => void`	—
`className`	`string`	—

About Tour Spotlight

Tour Spotlight is an onboarding tour that cuts a spotlight out of a dim overlay around each target and morphs the hole and its card from step to step.

Tour Spotlight is an overlay component for React 19, styled with Tailwind CSS 4 and animated with Motion. It drops into Next.js, Vite, Remix or Astro through the shadcn CLI as a single file you own.

When to use Tour Spotlight

Product onboarding.
Feature announcements.
Interactive help.
Setup walkthroughs.

How it works

Targets are CSS selectors measured on each step; the hole is an SVG mask rect animated on springs. The card is a modal dialog with arrow keys, Enter and Escape.

It traps and returns focus correctly, closes on Escape, and is announced to screen readers with the right dialog or menu role. With prefers-reduced-motion on, it holds still or settles instantly instead of animating.

Customizing Tour Spotlight

Every prop is documented in the API reference above with its type and default. The ones you will reach for first are listed here.

The Customize panel next to the preview lets you change padding, radius live, and the Code tab updates to match, so the snippet you copy already carries your values.

steps: target is a CSS selector.
open (boolean).
padding (number, default 8).
radius (number, default 12).
container (RefObject<HTMLElement>): Scope the tour to an element instead of the page.

Goes well with Tour Spotlight

These overlays pieces share its tokens and motion language, so they sit together on one page without clashing.

Command Menu: An animated React command palette with fuzzy search, groups and keyboard control
Hover Card: An animated React hover card that previews links on hover or focus
Morph Dialog: A React card that morphs into a dialog: artwork and title flow between them
Notification Stack: iOS-style grouped React notifications that fan out and swipe away
Dynamic Island: A React Dynamic Island: a pill that morphs size and content between states

Install Tour Spotlight

npx shadcn@latest add @charcoal/tour-spotlight

Tour Spotlight is part of Charcoal UI Pro. One seat unlocks all 300 Pro components, 107 landing-page sections and 100 full templates, for every personal and client project, with updates included. Add the @charcoal registry once with your access token, then the command above copies tour-spotlight.tsx into components/ui and installs clsx, tailwind-merge.

You own the file you install: no runtime package, no lock-in, nothing to keep in sync. Change it however your product needs.

See Charcoal UI Pro pricing · Pro setup

Frequently asked questions

Can the tour target any element?: Yes. Each step's target is a CSS selector, and the spotlight measures and frames whatever it matches.
How do I install Tour Spotlight?: Tour Spotlight is part of Charcoal UI Pro. Add the @charcoal registry to components.json with your access token, then run npx shadcn@latest add @charcoal/tour-spotlight. It copies tour-spotlight.tsx into components/ui and installs motion, clsx, tailwind-merge.
Is Tour Spotlight free for commercial use?: Tour Spotlight needs a Charcoal UI Pro seat, monthly or a one-time lifetime price. A seat covers unlimited personal and commercial projects, including client work, and every future Pro component.
Does Tour Spotlight work with Next.js?: Yes. It is a client component for React 19 styled with Tailwind CSS 4, so it works in the Next.js App Router and Pages Router, Vite, Remix and Astro.
Can an AI coding agent install Tour Spotlight?: Yes. Connect the Charcoal UI MCP server (https://charcoalui.com/mcp) to Claude Code, Cursor or any MCP client; get_component returns Tour Spotlight's props and get_install_command returns the exact command.

Tour Spotlight as Markdown · llms.txt