javascript/element-plus
1
0
Fork 0
mirror of https://github.com/element-plus/element-plus.git synced 2026-03-13 07:51:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: [tour] supplementary missing attributes (#20504)

Browse Source
This commit is contained in:
betavs
2025-04-21 19:29:59 +08:00
committed by GitHub
parent 22c3abc32d
commit 7dd646e3c1
1 changed files with 17 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
docs/en-US/component/tour.md
View File

@@ -75,21 +75,23 @@ tour-step component configuration with the same name has higher priority
### Tour Attributes
| Property | Description | Type | Default |
| ------------------------- | -------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ |
| show-arrow | whether to show the arrow | `boolean` | true |
| placement | position of the guide card relative to the target element | ^[enum]`'top' \| 'top-start' \| 'top-end' \| 'bottom' \| 'bottom-start' \| 'bottom-end' \| 'left' \| 'left-start' \| 'left-end' \| 'right' \| 'right-start' \| 'right-end'` | `bottom` |
| content-style | custom style for content | `CSSProperties` | — |
| mask | whether to enable masking, change mask style and fill color by pass custom props | `boolean` \| ^[Object]`{ style?: CSSProperties; color?: string; }` | `true` |
| type | type, affects the background color and text color | `default` \| `primary` | `default` |
| model-value / v-model | open tour | `boolean` | — |
| current / v-model:current | what is the current step | `number` | — |
| scroll-into-view-options | support pass custom scrollIntoView options | `boolean` \| `ScrollIntoViewOptions` | ^[Object]`{ block: 'center' }` |
| z-index | Tour's zIndex | `number` | `2001` |
| show-close | whether to show a close button | `boolean` | `true` |
| close-icon | custom close icon, default is Close | `string` \| `Component` | — |
| close-on-press-escape | whether the Dialog can be closed by pressing ESC | `boolean` | `true` |
| target-area-clickable | whether the target element can be clickable, when using mask | `boolean` | `true` |
| Property | Description | Type | Default |
| ------------------------- | -------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
| append-to | which element the TourContent appends to | ^[CSSSelector] / ^[HTMLElement] | `body` |
| show-arrow | whether to show the arrow | `boolean` | true |
| placement | position of the guide card relative to the target element | ^[enum]`'top' \| 'top-start' \| 'top-end' \| 'bottom' \| 'bottom-start' \| 'bottom-end' \| 'left' \| 'left-start' \| 'left-end' \| 'right' \| 'right-start' \| 'right-end'` | `bottom` |
| content-style | custom style for content | `CSSProperties` | — |
| mask | whether to enable masking, change mask style and fill color by pass custom props | `boolean` \| ^[Object]`{ style?: CSSProperties; color?: string; }` | `true` |
| gap | transparent gap between mask and target | `TourGap` | ^[Object]`{ offset: 6, radius: 2}` |
| type | type, affects the background color and text color | `default` \| `primary` | `default` |
| model-value / v-model | open tour | `boolean` | — |
| current / v-model:current | what is the current step | `number` | — |
| scroll-into-view-options | support pass custom scrollIntoView options | `boolean` \| `ScrollIntoViewOptions` | ^[Object]`{ block: 'center' }` |
| z-index | Tour's zIndex | `number` | `2001` |
| show-close | whether to show a close button | `boolean` | `true` |
| close-icon | custom close icon, default is Close | `string` \| `Component` | — |
| close-on-press-escape | whether the Dialog can be closed by pressing ESC | `boolean` | `true` |
| target-area-clickable | whether the target element can be clickable, when using mask | `boolean` | `true` |
### Tour slots