Skip to content

Commit 7042dde

Browse files
committed
docs(VTour): Updated props docs
1 parent 885bc8b commit 7042dde

1 file changed

Lines changed: 9 additions & 8 deletions

File tree

docs/guide/props.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@
44
VueJS Tour is written for Vue 3. There are no plans to support Vue 2.x
55
:::
66

7-
| Prop | Type | Default | Required | Description |
8-
|:--------------:|:---------:|:---------------------------------------------------------------:|:--------:|-----------------------------------------------------------------------------|
9-
| `name` | `String` | `default` | `false` | The name used for this tour. |
10-
| `steps` | `Array` | `undefined` | `true` | An array of steps to be used in the tour. |
11-
| `autoStart` | `Boolean` | `false` | `false` | If `true`, the tour will start automatically when the component is mounted. |
12-
| `startDelay` | `Number` | `0` | `false` | If set, the tour will start after x miliseconds. |
13-
| `highlight` | `Boolean` | `false` | `false` | If `true`, the target will get highlighted. |
14-
| `buttonLabels` | `Object` | `{ next: "Next", prev: "Back", finish: "Finish", skip: "Skip"}` | `false` | The labels used for the buttons. |
7+
| Prop | Type | Default | Required | Description |
8+
|:------------------:|:---------:|:---------------------------------------------------------------:|:--------:|---------------------------------------------------------------------------|
9+
| `name` | `String` | `default` | `false` | The name used for this tour. |
10+
| `steps` | `Array` | `undefined` | `true` | An array of steps to be used in the tour. |
11+
| `autoStart` | `Boolean` | `false` | `false` | If `true`, the tour will start automatically when the component is mounted. |
12+
| `startDelay` | `Number` | `0` | `false` | If set, the tour will start after x miliseconds. |
13+
| `highlight` | `Boolean` | `false` | `false` | If `true`, the target will get highlighted. |
14+
| `buttonLabels` | `Object` | `{ next: "Next", prev: "Back", finish: "Finish", skip: "Skip"}` | `false` | The labels used for the buttons. |
15+
| `saveToLocalStorage` | `String` | `end` | `false` | The save mode used for this tour.<br><br>`end` `step` `custom` |
1516

1617
## Example
1718

0 commit comments

Comments
 (0)