# Product Tour

> A guided onboarding walkthrough: the page dims around a spotlight that glides from target to target, and a step card anchors beside each with an arrow, flipping sides when there's no room and following its target through scroll and resize. Progress dots, Back/Next/Done, Skip, arrow keys and Escape; a modal dialog that traps Tab, announces steps and returns focus.

- Slug: `product-tour`
- Category: [Popovers](https://www.assembli.design/category/popovers.md)
- Type: component
- Tags: tour, onboarding, walkthrough, coachmark, spotlight, popover, dialog
- npm dependencies: lucide-react
- shadcn/ui dependencies: none
- Live preview: https://www.assembli.design/preview/product-tour
- Page: https://www.assembli.design/components/product-tour

![Product Tour preview](https://www.assembli.design/thumbnails/product-tour-light.png)

## Props

Other props pass through to the root element.

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `steps` (required) | `TourStep[]` |  |  |
| `open` | `boolean` |  |  |
| `defaultOpen` | `boolean` | `false` |  |
| `onOpenChange` | `(open: boolean) => void` |  |  |
| `step` | `number` |  | Controlled step index. |
| `onStepChange` | `(step: number) => void` |  |  |
| `onFinish` | `() => void` |  | Fires when the last step's Done button is pressed (not on skip or Escape). |
| `padding` | `number` | `6` | Space between the target and the cut-out edge, in px. |
| `className` | `string` |  |  |

## Install

One-time setup (needs a subscription):

1. Add the registry to the project's `components.json`: `{"@assembli":{"url":"https://www.assembli.design/r/{name}.json","headers":{"Authorization":"Bearer ${ASSEMBLI_API_KEY}"}}}` (merge into `"registries"`).
2. Put an API key from https://www.assembli.design/account in `.env.local` as `ASSEMBLI_API_KEY=asm_…`.

Then install with the shadcn CLI (writes `components/product-tour/product-tour.tsx` and installs dependencies):

```bash
npx shadcn@latest add @assembli/product-tour
```

Registry item JSON: https://www.assembli.design/r/product-tour.json (send `Authorization: Bearer <api key>`)

## Code

> Component source needs an Assembli subscription ($12/month or $96/year) and an API key sent as `Authorization: Bearer <key>`. To get one without copying anything, POST https://www.assembli.design/api/agent/login (or call the MCP tool connect_account), show the user the link it returns, and poll https://www.assembli.design/api/agent/token for the key. Or subscribe at https://www.assembli.design/pricing and create a key at https://www.assembli.design/account.