Skip to content

Tour 漫游式引导 ​

分步高亮页面元素并展示说明气泡,用于新功能引导。

基础用法 ​

vue
<template>
  <button id="tour-target">引导目标</button>
  <KbTour v-model="open" :steps="steps" />
</template>

<script setup>
import { ref } from 'vue'
const open = ref(false)
const steps = [
  { target: '#tour-target', title: '第一步', description: '这是要被高亮的元素', placement: 'bottom' },
  { title: '第二步', description: '不传 target 时气泡居中展示' },
]
</script>

引导目标

气泡位置 ​

placement 可取 top / bottom / left / right,默认 bottom。不传 target 的步骤会居中显示,且不渲染高亮框。

vue
<template>
  <KbTour v-model="open" :steps="[{ target: '#box', title: '标题', placement: 'right' }]" />
</template>

关闭方式 ​

方式说明
跳过show-skip 为 true(默认)时展示「跳过」按钮
遮罩mask-closable 为 true(默认)时点击遮罩关闭
关闭按钮气泡右上角 ×
最后一步按钮变为「结束引导」,点击后派发 finish 并关闭

API ​

Props ​

属性类型默认值说明
modelValuebooleanfalse是否显示
stepsTourStep[][]步骤列表
currentnumber0当前步骤下标
showSkipbooleantrue是否展示跳过按钮
maskClosablebooleantrue点击遮罩是否关闭

TourStep 字段:target?(选择器)、title、description?、placement?。

事件 ​

事件参数说明
update:modelValueboolean关闭时派发
update:currentnumber步骤变化
changenumber步骤变化
finish—在最后一步点击「结束引导」