跳到主要内容

Tour 漫游引导 ​

WebH5

漫游式引导。按步骤依次高亮页面目标元素并弹出说明气泡,支持上一步/下一步/跳过,target 为 null 时气泡居中展示。

何时使用 ​

新用户上手、新功能发布、复杂流程的分布讲解。

何时不使用 ​

单点提示用 Tooltip/Popover;步骤超过 5 个考虑改用帮助文档。

Props ​

名称类型默认值说明
modelValuebooleanfalse显隐,配合 v-model 使用
stepsTourStep[]-引导步骤,每项形如 { target, title, description }:target 为目标元素 CSS 选择器,null 表示无目标居中展示;title 为步骤标题;description 为可选描述
currentnumber0当前步骤索引,配合 v-model:current 使用;不绑定时组件内部维护步骤,点击上一步/下一步即可推进
showClosebooleantrue是否显示右上角关闭按钮

Events ​

名称载荷说明
update:modelValueboolean显隐变化时触发
update:currentnumber步骤切换时触发
finishvoid最后一步点击“完成”时触发(随后自动关闭)
closevoid关闭(关闭按钮/跳过/Escape/完成)时触发

示例 ​

新功能上线引导 ​

示例加载中…

无目标居中展示 ​

示例加载中…

受控步骤(v-model:current) ​

示例加载中…

Playground ​

加载中…

跨端版本 ​

该组件同时提供 uni-app / uni-app X 实现(H5 / 微信小程序 / App),API 可能略有差异,见 uni-app 端 Tour 文档(含手机预览)。