介绍

基于 shepherd.js 封装的 Vue.js 版本的新手引导组件。

使用场景

新功能指引、功能介绍。

快速开始

推荐使用 yarn 来管理依赖。

1、安装

yarn add @wytxer/shepherd-vue

2、导入。

支持两种导入方式使用。第一种是全局导入：

import Vue from 'vue'
import Shepherd from '@wytxer/shepherd-vue'

Vue.use(Shepherd)

// 会在 Vue 实例上挂载 $shepherd 函数，通过调用 $shepherd 函数来使用
this.$shepherd(config)

另一种是局部导入使用：

import { shepherd } from '@wytxer/shepherd-vue'

// 使用
shepherd(config)

config 的具体配置参见这里

使用文档

全局使用

使用 Vue.use 来挂载到全局，然后通过调用 $shepherd 函数来使用。

显示代码

代码和文档

shepherdjs API (opens new window)

shepherd-vue GitHub 地址 (opens new window)

组件已集成到中后台前端脚手架 (opens new window)，欢迎使用~