1.0.3 • Published 2 years ago

intro-vue-simple v1.0.3

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

用户引导

一个 vue2 插件

简单上手

#安装 install
npm install intro-vue2
<!-- 标记 mark -->
<div data-intro="1"></div>
//插件方式
import introVue2 from 'intro-vue2';

Vue.use(introVue2);


this.$intro({
    options: {
        domAttrFlag: "data-intro",
        targetClickEnable: true,
        clickTargetNext: true,
        scrollToTarget: true,
        tipCls: "",
        showBtn: true,
        nextLabel: "下一步",
        prevLable: "上一步",
        skipLable: "跳过",
        exitLable: "完成",
        autoNext: true,
        autoNextTime: 5,
    },
    steps: [
        {
            step: "1",
            tip: "点击这里1",
            afterEnter(updateTip){
                updateTip('2','更改了第二步提示')
            },
            beforeNext(next) {
                next("2");
            }
        },
        {
            step: "2",
            tip: "点击这里2",
            afterEnter(updateTip){
                updateTip('3','更改了第三步的提示')
            },
        },
        {
            step: "3",
            tip: "点击这里3",
            targetClickEnable: false
        },
        {
            step: "4",
            tip: "点击这里4",
            clickTargetNext: false
        }
    ]
})

//直接引入
import {intro} from 'intro-vue2';

intro({...})

注意: 要在dom渲染之后调用 例如:mounted

API

参数说明类型默认值
options配置参数Object{}
steps步骤Array[]

options

参数说明类型默认值
domAttrFlagdom 标记String'data-intro'
targetClickEnable目标区域是否可以点击Booleantrue
clickTargetNext点击目标区域自动执行下一步Booleantrue
scrollToTarget滚动到目标区域Booleantrue
tipCls自定义提示框样式String''
showBtn是否显示按钮Booleantrue
nextLabel下一步文案String'下一步'
prevLable上一步文案String'上一步'
skipLable跳过文案(最后一步之前展示)String'跳过'
exitLable最后一步结束文案String'完成'
autoNext是否自动下一步Booleantrue
autoNextTime自动下一步时间(秒)Number5

step

参数说明类型默认值
step步骤 keyStringundefined
tip提示文案,支持 html 片段Stringundefined
targetClickEnable目标区域是否可以点击Booleantrue
clickTargetNext点击目标区域自动执行下一步Booleantrue
afterEnter进入某一步之后回调Functionundefined
beforeNext进入下一步之前拦截,调用 next() 执行下一步Function(next)undefined