Tour 漫游式引导
用于引导用户了解产品的弹层组件。需要在产品导览场景时使用。
基础用法
最基础的用法。
非模态
使用 :mask="false" 可关闭遮罩模态。建议同时配合 type="primary" 突出引导本身。
位置
可调整引导卡片相对目标的位置,共 12 种。target 为空时引导显示在屏幕中央。
自定义遮罩样式
自定义遮罩样式。
自定义指示器
自定义步骤指示器。
目标元素
target 支持多种传参方式,包括字符串与函数类型。
漫游式引导 API
TIP
与 tour-step 组件同名的配置项,步骤组件优先级更高。
漫游式引导 属性
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| append-to | TourContent 挂载到的元素 | CSSSelector / HTMLElement | body |
| show-arrow | 是否显示箭头 | boolean | true |
| placement | 引导卡片相对目标的位置 | enum | bottom |
| content-style | 内容自定义样式 | CSSProperties | — |
| mask | 是否启用遮罩;可传入对象自定义遮罩样式与填充色 | boolean | Object | true |
| gap | 遮罩与目标之间的透明间隙 | TourGap | Object |
| type | 类型,影响背景色与文字颜色 | default | primary | default |
| model-value / v-model | 是否打开引导 | boolean | false |
| current / v-model:current | 当前步骤索引 | number | 0 |
| scroll-into-view-options | 自定义 scrollIntoView 选项 | boolean | ScrollIntoViewOptions | Object |
| z-index | 层级 | number | 2001 |
| show-close | 是否显示关闭按钮 | boolean | true |
| close-icon | 自定义关闭图标,默认为 Close | string | Component | — |
| close-on-press-escape | 是否可通过 ESC 关闭 | boolean | true |
| target-area-clickable | 使用遮罩时目标区域是否可点击 | boolean | true |
漫游式引导 插槽
| 名称 | 说明 | 类型 |
|---|---|---|
| default | 步骤组件列表 | — |
| indicators | 自定义指示器 | object |
漫游式引导 事件
| 名称 | 说明 | 类型 |
|---|---|---|
| close | 关闭时回调 | Function |
| finish | 完成时回调 | Function |
| change | 步骤变化时回调 | Function |
漫游步骤 API
漫游步骤 属性
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| target | 引导指向的元素;为空则在屏幕中央显示。支持字符串与函数;字符串为 document.querySelector 选择器 | HTMLElement | string | Function | — |
| show-arrow | 是否显示箭头 | boolean | — |
| title | 标题 | string | — |
| description | 描述 | string | — |
| placement | 引导卡片相对目标的位置 | enum | bottom |
| content-style | 内容自定义样式 | CSSProperties | — |
| mask | 是否启用遮罩;可传入对象自定义遮罩样式与填充色 | boolean | Object | — |
| type | 类型,影响背景色与文字颜色 | default | primary | default |
| next-button-props | 「下一步」按钮属性 | Object | — |
| prev-button-props | 「上一步」按钮属性 | Object | — |
| scroll-into-view-options | 自定义 scrollIntoView 选项,默认继承 Tour 的 scrollIntoViewOptions | boolean | ScrollIntoViewOptions | — |
| show-close | 是否显示关闭按钮 | boolean | — |
| close-icon | 自定义关闭图标,默认为 Close | string | Component | — |
漫游步骤 插槽
| 名称 | 说明 |
|---|---|
| default | 自定义描述 |
| header | 自定义头部 |
漫游步骤 事件
| 名称 | 说明 | 类型 |
|---|---|---|
| close | 关闭时回调 | Function |