Vue3-quick-tour NPM

vue3-quick-tour

全屏漫游式指引解决方案

antd 的感觉有点生硬，没有过度效果 https://ant-design.antgroup.com/components/tour-cn

demo https://codesandbox.io/p/sandbox/elated-solomon-uqfc8e?file=%2Fsrc%2FApp.vue

用法

 npm install vue3-quick-tour -D
 yarn add vue3-quick-tour -D
 pnpm add vue3-quick-tour -D

 <script setup lang="ts">
   import { Tour, type TourStep } from 'vue3-quick-tour'

   const steps: TourStep[] = [
     el: null,
     title: 'hello',
     message: '您好，这是一个基础示例',
   ]
 </script>
 <template>
   <Tour :steps="steps" :show="true" :current="0" />
 </template>

1. 特点

vue3 + tsx。
css-render 不生成 css 文件，也无需引入。
transition-hooks 自定义遮罩动画、弹出框动画。
可配置自定义主题，完美融入您的系统。
12个定位可选，也支持自动定位。

feature： 6. 自定义位置... 7. dark mode...

2. props

属性	传值	默认值	说明
steps	TourStep[]		每步的配置，必填
classPrefix	string	"quick"	全局 class 前缀
mask	boolean / MaskConfig	true	全局 mask 配置
v-model:current	number	0	当前步骤，支持非受控模式
v-model:show	boolean	false	是否展示引导，支持非受控模式
arrow	boolean	true	是否展示箭头
padding	number / { x: number, y: number }	5	指引元素的水平垂直边距
maskZIndex	number / string	1001	遮罩层的 z-index 值
dialogShowClose	boolean	true	是否展示关闭 icon
modalTransition	TransitionLifeCycleProps	undefined	自定义弹框动画
maskTransition	TransitionLifeCycleProps	undefined	自定义遮罩动画
maskTransition	TransitionLifeCycleProps	undefined	自定义遮罩动画
globalThemeOverrides	GlobalThemeOverrides	-	自定义主题配置

3. 详细配置说明

1. TourStep

值	类型	默认值	说明
el	null () => HTMLElment	null	指引对象，为 null 时全屏居中
title	string	undefined	弹框标题
message	string	undefined	弹框内容
placement	TourItemPlacement	bottom	弹框相对于指引目标位置
mask	boolean / MaskConfig	undefined	当前步骤 mask 配置 undefined 时随全局配置

type TourItem = top | bottom | left | right | top-start | top-end | left-start | left-end | right-start | right-end | bottom-start | bottom-end

2. MaskConfig

值	类型	默认值	说明
style	CSSProperties、undefined	undefined	mask-wrapper 样式
color	string、undefined	rgba(0,0,0,0.5)	遮罩颜色

3. TransitionLifeCycleProps（您需预设好 el.style，剩下的交给我来执行）

以弹出层默认过渡动画为例：

值	类型	默认值	说明
onBeforeEnter	(el: HTMLElement) => void	el.style.transform = "scale(1.06, 1.06)"; el.style.opacity = '0';	进入开始的状态，形同 v-enter-from
onEnter	(el: HTMLElement) => void	el.style.transform = "scale(1, 1)"; el.style.opacity = '1'	进入结束的状态
onLeave	(el: HTMLElement) => void	el.style.transformOrigin = "bottom left"; el.style.transform = "scale(0, 0)";　 el.style.opacity = "0";	离开的结束状态

4. GlobalThemeOverrides

interface GlobalThemeOverrides {
 common?: {
   primaryColor?: string;
   bezier?: string;
   lineHeight?: number | string;
   duration?: number;
   borderRadiusSmall?: string;
   borderRadius?: string;
   borderRadiusLarge?: string;
   borderColor?: string;
 };
 dot?: {
   backgroundColor?: string;
   primaryColor?: string;
   size?: number;
   bezier?: string;
   duration?: number;
   gap?: number;
 };
 modal?: {
   closeIconSize?: number;
   closeIconBackgroundColor?: string;
   titleFontSize?: string;
   titleFontWeight?: string;
   lineHeight?: string | number;
   bezier?: string;
   duration?: number;
   backgroundColor?: string;
   color?: string;
 };
 mask?: {
   bezier?: string;
   duration?: number;
 };
 button?: {
   primaryColor?: string;
   height?: string;
 };
}

4. emits

事件名	说明
update:current	更新当前步骤
update:show	更新展示引导
change	步骤变换触发
next	下一步触发事件
prev	上一步触发事件
finish	指引结束事件
open	打开事件
opened	完全打开事件（动画结束）
close	关闭时间
closed	完全结束事件（动画结束）

5. slots

插槽名	scoped values	说明
default	close（关闭）、current（当前）、currentStep（当前详情信息）、next（下一步）、prev（上一步）、last（最后一步）、steps（步骤集合）	完全支持您自己渲染指引提示内容
close	close（关闭）、current（当前）、currentStep（当前详情信息）	自定义渲染关闭 icon
title	currentStep（当前详情信息）	自定义渲染 title
content	currentStep（当前详情信息）	自定义渲染 message
...	...	更多的在路上