Tour 漫游式引导

用于分步引导用户了解产品功能的气泡组件。通过高亮目标区域并展示引导提示,帮助用户快速熟悉产品功能。

综合演示
模拟一个简洁的管理后台界面,点击「开始引导」开启完整的漫游式引导流程。
首页
订单
设置
帮助
1,280
总订单
86%
完成率
¥52.8k
总收入
快捷操作区
基础用法
最简单的引导,通过 steps 定义引导步骤,使用 v-model:open 控制显隐。
弹出位置
通过 placement 属性设置气泡弹出方向,支持 12 个方位。
无遮罩模式
设置 mask 为 false 关闭遮罩,用户可以正常操作页面其他区域。
自定义按钮文字
通过 prevText、nextText、finishText 自定义底部按钮文字。
自定义步骤内容
使用 #step-{index} 作用域插槽自定义每一步的描述内容。
事件回调
监听 change、close、finish 事件,获取引导流程的状态变化。

Props

参数类型默认值说明
stepsTourStep[]引导步骤数据(必填)
currentnumber0当前步骤索引,支持 v-model:current
openbooleanfalse是否显示引导,支持 v-model:open
placementPlacement'bottom'气泡默认弹出位置,可被步骤单独覆盖
maskbooleantrue是否显示遮罩
showClosebooleantrue是否显示关闭按钮
closeOnOverlaybooleantrue点击遮罩是否关闭引导
scrollIntoViewbooleantrue是否自动滚动到目标元素
prevTextstring'上一步'上一步按钮文字
nextTextstring'下一步'下一步按钮文字
finishTextstring'完成'完成按钮文字
gapnumber8气泡与目标元素的间距(px)

TourStep

参数类型默认值说明
targetstring目标元素 CSS 选择器(必填)
titlestring步骤标题
descriptionstring步骤描述内容
placementPlacement该步骤的弹出位置,优先级高于全局 placement

Events

事件名类型说明
change(current: number) => void当前步骤变化时触发
close(current: number) => void关闭引导时触发
finish() => void引导完成时触发

Slots

插槽名说明
step-{index}自定义第 index 步的内容,作用域参数 { step, current }

Methods

方法名类型说明
updatePos() => void手动更新气泡位置