From 7dd646e3c1d7ec4ee4ad24f960d6aaef8754ae7e Mon Sep 17 00:00:00 2001 From: betavs <34408516+betavs@users.noreply.github.com> Date: Mon, 21 Apr 2025 19:29:59 +0800 Subject: [PATCH] docs: [tour] supplementary missing attributes (#20504) --- docs/en-US/component/tour.md | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/docs/en-US/component/tour.md b/docs/en-US/component/tour.md index f1723281fd..a0ce56d90b 100644 --- a/docs/en-US/component/tour.md +++ b/docs/en-US/component/tour.md @@ -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