# Tour Spotlight · Pro

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.

This is a Charcoal UI Pro component. Its source and examples are available with a Pro seat: https://charcoalui.com/pricing

## With a Pro seat

1. Add the registry to components.json:

```json
{
  "registries": {
    "@charcoal": {
      "url": "https://charcoalui.com/r/{name}.json",
      "headers": {
        "Authorization": "Bearer ${CHARCOAL_LICENSE_KEY}"
      }
    }
  }
}
```

2. Copy your licence key from https://charcoalui.com/dashboard and put it in .env.local as CHARCOAL_LICENSE_KEY, then:

```bash
npx shadcn@latest add @charcoal/tour-spotlight
```

To read Pro source through this MCP server, reconnect it with the header "Authorization: Bearer <licence key>".

## API — Tour Spotlight
| Prop | Type | Default | Notes |
| --- | --- | --- | --- |
| `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` | — |  |

See it live: https://charcoalui.com/docs/components/tour-spotlight