Tour 漫游导览

用于引导用户了解产品的弹出组件。当你想要引导用户了解产品时使用。

基础用法

最基本的使用

非模态

使用 :mask="false" 使导览变为非模态。同时建议配合 type="primary" 使用以强调引导本身。

位置

更改引导相对于目标的位置,共有 12 种位置可选。当 target 为空时,引导将显示在屏幕中心。

自定义遮罩样式

自定义遮罩样式。

自定义指示器

自定义指示器。

目标

target 支持多种参数传递类型。自 2.5.2 起支持字符串和函数类型。

Tour API

提示

具有相同名称的 tour-step 组件配置优先级更高

Tour 属性

属性描述类型默认值
append-toTourContent 追加到哪个元素CSSSelector / HTMLElementbody
show-arrow是否显示箭头booleantrue
placement引导卡片相对于目标元素的位置枚举bottom
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-indexTour 的 zIndexnumber2001
show-close是否显示关闭按钮booleantrue
close-icon自定义关闭图标,默认为 Closestring | Component
close-on-press-escape是否可以通过按 ESC 键关闭对话框booleantrue
target-area-clickable在使用遮罩时,目标元素是否可以点击booleantrue

Tour 插槽

名称描述类型
defaulttourStep 组件列表
indicators自定义指示器object

Tour 事件

名称描述类型
关闭关闭时的回调函数Function
finish完成时的回调函数Function
change步骤变化时的回调Function

TourStep API

TourStep 属性

属性描述类型默认值
target获取引导卡片指向的元素。为空时显示在屏幕中央。自 2.5.2 起支持字符串和函数类型。字符串类型为 document.querySelector 的选择器。HTMLElement | string | Function
show-arrow是否显示箭头boolean
titletitlestring
descriptiondescriptionstring
placement引导卡片相对于目标元素的位置枚举bottom
content-style内容的自定义样式CSSProperties
mask是否启用遮罩,可以通过传递自定义属性来更改遮罩样式和填充颜色boolean | Object
type类型,影响背景颜色和文字颜色default | primarydefault
next-button-props“下一步”按钮的属性Object
prev-button-props“上一步”按钮的属性Object
scroll-into-view-options支持传递自定义的 scrollIntoView 选项,默认遵循 Tour 的 scrollIntoViewOptions 属性boolean | ScrollIntoViewOptions
show-close是否显示关闭按钮boolean
close-icon自定义关闭图标,默认为 Closestring | Component

TourStep 插槽

名称描述
default自定义描述内容
header自定义头部内容

TourStep 事件

名称描述参数
关闭关闭时的回调函数Function

来源

组件样式文档

贡献者