Skip to content

ZNN-She/maskGuide

Repository files navigation

#介绍 功能遮罩引导

#使用

import {guide, close} from "mask-guide";

guide({
    el: "2",
    type: "step",
    position: "bottomRight",
    onClickNext: () => {
        console.log("点击了下一步");
        close();
    }
    explain: {
        title: "这是title",
        content: "这是内容这是内容这是内容这是内容这是内容这是内容"
    }
});
<script src="mode_moudules/mask-guide/dist/index.js"></script>
maskGuide.guide({
    el: "2",
    type: "step",
    position: "bottomRight",
    onClickNext: () => {
        console.log("点击了下一步");
        maskGuide.close();
    }
    explain: {
        title: "这是title",
        content: "这是内容这是内容这是内容这是内容这是内容这是内容"
    }
});

#效果

#API

参数 说明 类型 默认值 是否必填 备注
el 需要引导的元素 id/Element
type 引导类型 String step
classWarp String
position 方向 String bottom top/left/right/bottom/topLeft/topRight/bottomLeft/bottomRight/leftTop/leftBottom/rightTop/rightBottom
targetPosition 引导位置 Object {top: 100, left: 100}
targetSize 引导空白未知的大小 Object {width: 100, height: 100}
onClickContainer 点击容器的回调,点击任何地方都会触发 Function
onClickTarget 点击target元素触发 Function
onClickNext 点击下一步触发 Function
onClickPrev 点击上一步触发 Function
onClickClose 关闭触发 Function
nextBtnText 下一步按钮文字 String 下一步
prevBtnText 上一步按钮文字 String 上一步
showNext 是否显示下一步按钮 Boolean true
showPrev 是否显示上一步按钮 Boolean true
showClose 是否显示关闭按钮 Boolean true
showArrow 是否显示箭头 Boolean true
showStar 是否显示星星 Boolean true 只在active有效,step没有星星
maskClosable 点击蒙层是否允许关闭 Boolean true
explain 说明modal Object/Boolean { width: 340 } false的时候不显示

explain

参数 说明 类型 默认值 是否必填 备注
width Number { width: 340 }
title String/Element
content String/Element

#升级日志

  • 增加点击容器的回调,点击任何地方都会触发

About

遮罩引导

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published