# html

# 浏览器兼容性

支持所有符合ES5标准的浏览器(不支持IE8及以下版本)

# 配置

在view/html文件夹copy到自己项目中
1)引入css文件verify.css <br/>
2)按顺序引入js文件下js文件 jquery.min.js, crypto-js.js, ase.js, verify.js

# 基础示例

准备初始化的容器,以及id值

     <div id="content"></div>
    //  mode="pop"模式配置点击
     <button id="btn">点击出现验证码</button>

滑动式调用$('#content').slideVerify(option)初始化;
点选式调用$('#content').pointsVerify(option)初始化;

**option为配置对象{},参数详见下方验证码参数**

<script>
    $('#content').slideVerify({
        baseUrl:'https://captcha.ruijie.com.cn/',  //服务器请求地址, 默认地址为安吉服务器;
        containerId:'btn',//pop模式 必填 被点击之后出现行为验证码的元素id
        mode:'pop',     //展示模式
        imgSize : {       //图片的大小对象,有默认值{ width: '310px',height: '155px'},可省略
            width: '400px',
            height: '200px',
        },
        barSize:{          //下方滑块的大小对象,有默认值{ width: '310px',height: '50px'},可省略
            width: '400px',
            height: '40px',
        },
        beforeCheck:function(){  //检验参数合法性的函数  mode ="pop"有效
            let flag = true;
            //实现: 参数合法性的判断逻辑, 返回一个boolean值
            return flag
        },
        ready : function() {},  //加载完毕的回调
        success : function(params) { //成功的回调
            // params为返回的二次验证参数 需要在接下来的实现逻辑回传服务器
            例如: login($.extend({}, params))
        },
        error : function() {}        //失败的回调
    });
</script>

# 回调事件

参数 类型 说明
success(params) funciton 验证码匹配成功后的回调函数,params为返回需回传服务器的二次验证参数
error funciton 验证码匹配失败后的回调函数
ready funciton 验证码初始化成功的回调函数
beforeCheck funciton mode="pop"模式有效, 调用验证码前检验参数合法性的函数,返回值为boolean值,默认返回ture

# 验证码参数

参数 类型 说明
baseUrl String 请求后端的服务器地址,默认:'https://captcha.ruijie.com.cn/'
mode String 验证码的显示方式,弹出式pop,固定fixed,默认:mode : ‘pop’
containerId String mode="pop" 模式必填,被点击之后出现行为验证码的元素id
vSpace String 验证码图片和移动条容器的间隔,默认单位是px。如:间隔为5px,默认:vSpace:5
explain String 滑动条内的提示,不设置默认是:'向右滑动完成验证'
imgSize Object 其中包含了width、height两个参数,分别代表图片的宽度和高度,如:{width:'400px',height:'200px'}

# 默认接口api地址

请求URL 请求方式
/captcha/get Post
/captcha/check Post