Skip to content

Commit ae9a4f5

Browse files
committed
[documentation] update documentation
1 parent d34e449 commit ae9a4f5

File tree

2 files changed

+18
-11
lines changed

2 files changed

+18
-11
lines changed

doc/stage-play-scene.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,30 @@
11
# StagePlayScene
22

3-
`<StagePlaySpotlight>` is the primary component used to highlight elements in a guided tour. Each `<StagePlayScene>` should be used within `<StagePlaySpotlight>`.
3+
The component used to configure each step in the guided tour. All the elements you wish to highlight in a single step must be placed within the slot of `<StagePlayScene>`.
44

5-
It's recommended to use it directly in the root component.
6-
7-
``` vue{2,6,10}
5+
``` vue{2,6,15}
86
<script setup lang="ts">
9-
import { StagePlaySpotlight } from 'vue-stage-play'
7+
import { StagePlayScene } from 'vue-stage-play'
108
</script>
119
1210
<template>
13-
<StagePlaySpotlight>
14-
<div class="root">
15-
<!-- ... -->
16-
</div>
17-
</StagePlaySpotlight>
11+
<StagePlayScene actName="demo" :scene="1">
12+
<template #default>
13+
<div class="title">
14+
<!-- ... -->
15+
</div>
16+
<div class="content">
17+
<!-- ... -->
18+
</div>
19+
</template>
20+
</StagePlayScene>
1821
</template>
1922
```
2023

24+
:::tip
25+
`<StagePlayScene>` will render an actual element. Hence, you may need to set the `margin` to it, rather than the highlighted elements.
26+
:::
27+
2128
## Props
2229

2330
<script setup>

doc/stage-play-spotlight.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# StagePlaySpotlight
22

3-
`<StagePlaySpotlight>` is the primary component used to highlight elements in a guided tour. Each `<StagePlayScene>` should be used within `<StagePlaySpotlight>`.
3+
The primary component used to highlight elements in a guided tour. Each `<StagePlayScene>` should be used within `<StagePlaySpotlight>`.
44

55
It's recommended to use it directly in the root component.
66

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy