/*
 * @Author: liusheng 1410739063@qq.com
 * @Date: 2022-06-14 17:02:21
 * @LastEditors: liusheng 1410739063@qq.com
 * @LastEditTime: 2022-06-15 17:12:58
 * @FilePath: \tjzh-common-mng\src\slidervcode\jsdoc.js
 * @Description: 这是为jsapi工具配置的专用文档
 */
/**
 * <b>滑块验证码组件</b><br/>
 * 引用示例：<br/>
 * &lt;slide-block-vcode <b>:vcodeImg</b>="vcodeImg" <b>:validateFunc</b>="handleValidate" <b>@refresh</b>="refreshImage" <b>@success</b>="handleSuccess" /&gt;<br/>
 * <br/>
 * 展示参数(vcodeImg)提供的背景图片和滑块图片，并提供滑块拖动验证。<br/>
 * 需提供验证函数(validateFunc)，以及图片刷新(@refresh)和验证成功(@success)的回调函数<br/>
 * @property {object} vcodeImg {<br/>
 *    &emsp;backgroundImg: Base64背景图,<br/>
 *    &emsp;slideBlockImg: Base64滑块图,<br/>
 *    &emsp;width: 背景图宽度px,<br/>
 *    &emsp;height: 背景图高度px,<br/>
 *    &emsp;blockWidth: 滑块图宽度px, <br/>
 *    &emsp;blockHeight: 滑块图高度px<br/>}
 * @property {function} validateFunc(offsetX) Promise化函数<br/>
 *    参数：offsetX = 用户选择的滑块位置<br/>
 *    返回：resolve为true/false表示验证成功或失败<br/>
 * @property {callback} refresh() 刷新图片函数(当验证错误后或人为点击刷新按钮时调用)<br/>
 *    刷新后的图片对象赋予vcodeImg属性即可，对象格式须与vcodeImg相同
 * @property {callback} success() 验证成功回调函数
 *
 * @Author: laoliu
 * @Date: 2022-6-14 11:43:23
 */
let SlideBlockVcode;

/**
 * <b>滑块验证对话框组件</b><br/>
 * 引用示例：<br/>
 * &lt;slider-vcode-dialog <b>:visible</b>="showSliderDlg" <b>@close-dialog</b>="handleCloseSliderDialog"/&gt;<br/>
 * <br/>
 * 该组件以对话框形式呈现，并实现滑块验证，是对SlideBlockVcode组件的高级封装<br/>
 * 组件内封装了SlideBlockVcode所需的vcodeImg、validateFunc、refresh、success，以及它们对后端接口的调用
 * @property {bool} visible true/false-是否显示该对话框
 * @property {callback} close-dialog(succ,imgVcode) 用户验证成功或取消验证（点X关闭了对话框）后的回调函数<br/>
 *    参数： succ - true/false 表示验证成功/取消验证（点X关闭了对话框）<br/>
 *           &emsp;&emsp;&emsp;&ensp;imgVcode - 验证码值，仅succ=true时有效
 * 
 * @Author: laoliu
 * @Date: 2022-6-14 11:43:23
 */
let SliderVcodeDialog;