# Tour API

> Auto-generated API reference for `Tour` from @vuetify/v0 (Vuetify0).
> Source of truth: https://0.vuetifyjs.com/api/tour

## Related

- https://0.vuetifyjs.com/components/disclosure/tour
- https://0.vuetifyjs.com/composables/plugins/use-tour
- https://0.vuetifyjs.com/components/disclosure/dialog
- https://0.vuetifyjs.com/components/disclosure/popover

## Tour.Root

### Props

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `step` | `ID` | — | yes | Step id this root represents |
| `namespace` | `string \| undefined` | `"v0:tour"` | no | Namespace for dependency injection |

### Slots

| Name | Type | Description |
|---|---|---|
| `default` | `TourRootSlotProps` | — |

## Tour.Activator

### Props

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `step` | `any` | — | yes | Step id or ids this activator belongs to |
| `padding` | `number \| undefined` | — | no | Extra padding reported to Tour.Highlight |
| `scroll` | `boolean \| undefined` | `true` | no | Scroll the activator into view when its step becomes active |
| `scrollOptions` | `ScrollIntoViewOptions \| undefined` | — | no | Options forwarded to `scrollIntoView` |
| `namespace` | `string \| undefined` | `"v0:tour"` | no | Namespace for dependency injection |

### Slots

| Name | Type | Description |
|---|---|---|
| `default` | `TourActivatorSlotProps` | — |

## Tour.Content

### Props

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `placement` | `any` | `"bottom"` | no | Preferred placement relative to the activator |
| `offset` | `number \| undefined` | `16` | no | Gap from the activator or viewport edge, in px |
| `namespace` | `string \| undefined` | `"v0:tour"` | no | Namespace for dependency injection |

### Slots

| Name | Type | Description |
|---|---|---|
| `default` | `TourContentSlotProps` | — |

## Tour.Description

### Props

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `namespace` | `string \| undefined` | `"v0:tour"` | no | Namespace for dependency injection |

### Slots

| Name | Type | Description |
|---|---|---|
| `default` | `TourDescriptionSlotProps` | — |

## Tour.Highlight

### Props

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `opacity` | `number \| undefined` | `0.5` | no | Backdrop opacity (0–1) |
| `padding` | `number \| undefined` | `0` | no | Extra padding around the cutout when the activator has none |
| `blocking` | `boolean \| undefined` | `false` | no | Swallow clicks on the backdrop. Does not stop the tour. |
| `blockActivator` | `boolean \| undefined` | `false` | no | Swallow clicks on the cutout. Does not stop the tour. |
| `namespace` | `string \| undefined` | `"v0:tour"` | no | Namespace for dependency injection |

### Slots

| Name | Type | Description |
|---|---|---|
| `default` | `TourHighlightSlotProps` | — |

## Tour.Keyboard

### Props

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `prev` | `string \| undefined` | `"arrowleft"` | no | Hotkey that moves to the previous step |
| `next` | `string \| undefined` | `"arrowright"` | no | Hotkey that moves to the next step |
| `stop` | `string \| undefined` | `"escape"` | no | Hotkey that stops the tour |
| `namespace` | `string \| undefined` | `"v0:tour"` | no | Namespace for dependency injection |

### Slots

| Name | Type | Description |
|---|---|---|
| `default` | `any` | — |

## Tour.Next

### Props

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `namespace` | `string \| undefined` | `"v0:tour"` | no | Namespace for dependency injection |
| `disabled` | `boolean \| undefined` | `false` | no | Override disabled state |

### Slots

| Name | Type | Description |
|---|---|---|
| `default` | `TourNextSlotProps` | — |

## Tour.Prev

### Props

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `namespace` | `string \| undefined` | `"v0:tour"` | no | Namespace for dependency injection |
| `disabled` | `boolean \| undefined` | `false` | no | Override disabled state |

### Slots

| Name | Type | Description |
|---|---|---|
| `default` | `TourPrevSlotProps` | — |

## Tour.Progress

### Props

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `namespace` | `string \| undefined` | `"v0:tour"` | no | Namespace for dependency injection |

### Slots

| Name | Type | Description |
|---|---|---|
| `default` | `TourProgressSlotProps` | — |

## Tour.Skip

### Props

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `namespace` | `string \| undefined` | `"v0:tour"` | no | Namespace for dependency injection |

### Events

| Name | Type | Description |
|---|---|---|
| `skip` | `[]` | — |

### Slots

| Name | Type | Description |
|---|---|---|
| `default` | `TourSkipSlotProps` | — |

## Tour.Title

### Props

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `namespace` | `string \| undefined` | `"v0:tour"` | no | Namespace for dependency injection |

### Slots

| Name | Type | Description |
|---|---|---|
| `default` | `TourTitleSlotProps` | — |