Skip to content

Commit c00c36c

Browse files
committed
docs: Updated Docs
1 parent 21e93ae commit c00c36c

8 files changed

Lines changed: 15 additions & 27 deletions

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,5 @@ dist-ssr
2727

2828
# Vitepress
2929
docs/.vitepress/dist
30-
docs/.vitepress/cache
30+
docs/.vitepress/cache
31+
*.tgz

docs/guide/roadmap.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,22 @@
44
🕔 = Postponed
55
🚧 = In Progress
66

7-
## 2.2.0 (2024-08-13) 🚧
7+
8+
## 2.4.0 (TBA) 🚧
9+
10+
* **Step:** Adding `arrow️` option
11+
* **VTour:** Adding `showProgress` prop
12+
13+
## 2.2.0 (2024-08-13) ✔️
814

915
### Features
1016

1117
* **VTour:** Adding `onTourStep` event ✔️
12-
* **VTour:** Adding `onBeforeStep` event ❌ (Changed to `onTourStep`)
13-
* **VTour:** Adding `onAfterStep` event ❌ (Changed to `onTourStep`)
14-
* **VTour:** Adding `showProgress` prop
18+
* **VTour:** Adding `onBeforeStep` event ❌ (Changed to `onTourStep`) ✔️
19+
* **VTour:** Adding `onAfterStep` event ❌ (Changed to `onTourStep`) ✔️
20+
* **VTour:** Adding `showProgress` prop
1521
* **VTour:** Adding `noScroll` prop ✔️
16-
* **Step:** Adding `arrow️` option
22+
* **Step:** Adding `arrow️` option
1723
* **Step:** Adding `noScroll` option ✔️
1824
* **Step:** Adding `backdrop` option ✔️
1925
* **Step:** Adding `highlight` option ✔️

docs/guide/scroll-to-element.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# Scroll to Element
22

3-
::: info
4-
This feature will be available in version [`2.2.0`](./roadmap#_2-2-0-2024-08-13-🚧).
5-
:::
6-
73
To disable scrolling, you can use the `noScroll` prop in the `VTour` component.
84

95
```vue

docs/guide/step-highlight-target.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
# Highlight Target Option
22
The `highlight` option is used to highlight the target element <u>per step</u>. This option is useful when you want to emphasize the target element.
33

4-
::: info
5-
This feature will be available in version [`2.2.0`](./roadmap#_2-2-0-2024-08-13-🚧).
6-
:::
7-
84
## Using the `highlight` option
95
To enable the highlight effect, you can set the `highlight` option in the `Step`.
106

docs/guide/step-scroll-to-element.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
To disable scrolling <u>per step</u>, you can use the `noScroll` option in the `Step`.
44

55
::: info
6-
This feature will be available in version [`2.2.0`](./roadmap#_2-2-0-2024-08-13-🚧).
6+
This feature will be available in version [`2.4.0`](./roadmap#_(TBA)-🚧).
77
:::
88

99
```vue

docs/guide/step-using-a-backdrop.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
# Using a Backdrop
22
The `backdrop` option is a boolean that represents whether the backdrop should be displayed or not <u>per step</u>. The backdrop is a semi-transparent overlay that covers the entire screen, except for the highlighted element.
33

4-
::: info
5-
This feature will be available in version [`2.2.0`](./roadmap#_2-2-0-2024-08-13-🚧).
6-
:::
74

85
## Using the `backdrop` option
96
To enable the backdrop, you can use the `backdrop` option in the `Step`.

docs/guide/the-onafter-event.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
# The onAfter Event
22

3-
The `onAfter` event is triggered after the step is shown. This event is useful when you want to do something after the step is shown.
4-
5-
::: info
6-
This feature will be available in version [`2.2.0`](./roadmap#_2-2-0-2024-08-13-🚧).
7-
:::
3+
The `onAfter` event is triggered after the step is shown. This event is useful when you want to do something after the step is shown.
84

95
```vue
106
<script setup>

docs/guide/the-onbefore-event.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
The `onBefore` event is triggered before the step is shown. This event is useful when you want to do something before the step is shown. For example, you can use this event to check if the user is allowed to see the step.
44

5-
::: info
6-
This feature will be available in version [`2.2.0`](./roadmap#_2-2-0-2024-08-13-🚧).
7-
:::
8-
95
```vue
106
<script setup>
117
const steps = [{

0 commit comments

Comments
 (0)