Tour 漫游式引导

用于引导用户了解产品的弹层组件。需要在产品导览场景时使用。

基础用法

最基础的用法。

非模态

使用 :mask="false" 可关闭遮罩模态。建议同时配合 type="primary" 突出引导本身。

位置

可调整引导卡片相对目标的位置,共 12 种。target 为空时引导显示在屏幕中央。

自定义遮罩样式

自定义遮罩样式。

自定义指示器

自定义步骤指示器。

目标元素

target 支持多种传参方式,包括字符串与函数类型。

漫游式引导 API

TIP

tour-step 组件同名的配置项,步骤组件优先级更高。

漫游式引导 属性

属性说明类型默认值
append-toTourContent 挂载到的元素CSSSelector / HTMLElementbody
show-arrow是否显示箭头booleantrue
placement引导卡片相对目标的位置enumbottom
content-style内容自定义样式CSSProperties
mask是否启用遮罩;可传入对象自定义遮罩样式与填充色boolean | Objecttrue
gap遮罩与目标之间的透明间隙TourGapObject
type类型,影响背景色与文字颜色default | primarydefault
model-value / v-model是否打开引导booleanfalse
current / v-model:current当前步骤索引number0
scroll-into-view-options自定义 scrollIntoView 选项boolean | ScrollIntoViewOptionsObject
z-index层级number2001
show-close是否显示关闭按钮booleantrue
close-icon自定义关闭图标,默认为 Closestring | Component
close-on-press-escape是否可通过 ESC 关闭booleantrue
target-area-clickable使用遮罩时目标区域是否可点击booleantrue

漫游式引导 插槽

名称说明类型
default步骤组件列表
indicators自定义指示器object

漫游式引导 事件

名称说明类型
close关闭时回调Function
finish完成时回调Function
change步骤变化时回调Function

漫游步骤 API

漫游步骤 属性

属性说明类型默认值
target引导指向的元素;为空则在屏幕中央显示。支持字符串与函数;字符串为 document.querySelector 选择器HTMLElement | string | Function
show-arrow是否显示箭头boolean
title标题string
description描述string
placement引导卡片相对目标的位置enumbottom
content-style内容自定义样式CSSProperties
mask是否启用遮罩;可传入对象自定义遮罩样式与填充色boolean | Object
type类型,影响背景色与文字颜色default | primarydefault
next-button-props「下一步」按钮属性Object
prev-button-props「上一步」按钮属性Object
scroll-into-view-options自定义 scrollIntoView 选项,默认继承 TourscrollIntoViewOptionsboolean | ScrollIntoViewOptions
show-close是否显示关闭按钮boolean
close-icon自定义关闭图标,默认为 Closestring | Component

漫游步骤 插槽

名称说明
default自定义描述
header自定义头部

漫游步骤 事件

名称说明类型
close关闭时回调Function