1.3.0 • Published 2 years ago

cxvalidation v1.3.0

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

cxValidation

主要面向移动端的表单验证插件,能快速方便的验证表单和单个输入控件,支持基本的验证规则和自定义验证规则。

Demo: http://ciaoca.github.io/cxValidation/

使用方法

载入 JavaScript 文件

<script src="cxvalidation.js"></script>

调用

/**
 * 获取验证结果
 * @returns {object} result
 */
cxValidation(document.getElementById('input_or_form'));

// 检验并提示
cxValidation.verify(document.getElementById('input_or_form'));

// 绑定表单的提交事件,验证通过后才会提交
cxValidation.attach(document.getElementById('form'));

result 验证结果

名称类型说明
statusboolean验证结果
messagestring提示消息
rulestring验证未通过的的规则名称
elementelement验证未通过的元素

API 接口

名称说明
verify(element, options)检验并提示
attach(element, options)绑定表单验证
detach(element)解除表单验证
setRules(options)设置验证规则
setOptions(options)设置默认配置
setLanguage(options)设置默认语言

verify, attach, setOptions 参数说明

名称默认值说明
completeundefined验证完成时回调函数
successfunction验证通过时回调函数
errorfunction验证未通过时回调函数
// 表单验证未通过时,默认处理方法,建议搭配对话框插件进行提示
cxValidation.setOptions({
  error: function(result) {
    console.log(result);
  }
});

// 自定义表单验证完成后的处理方式
cxValidation.attach(document.getElementById('form'), {
  // 验证完成
  complete: function(result) {
    console.log('验证完成', result);
  },
  // 验证通过(定义该函数后,验证通过后表单将阻止提交)
  success: function(result) {
    console.log('验证通过', result);
  },
  // 验证未通过(用于展示提示信息)
  error: function(result) {
    console.log('验证未通过', result);
  }
});

setLanguage 语言配置

// 自定义提示语言,完整配置可参考源码 validMessage
cxValidation.setLanguage({
  titleSymbol: {
    before: '',
    after: '',
  },
  required: {
    input: '必填项'
  },
  email: '请填写正确的邮箱地址'
});

setRules 自定义验证规则

<input data-validation="myFun1[arg1][arg2]">
// 第一个参数为当前验证的输入控件
cxValidation.setRules({
  myFun1: function(el, arg1, arg2) {
    // 返回验证结果对象
    return {
      status: el.value === arg1,  // true: 通过, false: 未通过
      message: '请填写 ' + arg1    // 提示信息
    };
  },
  myFun2: function(el, arg1, arg2) {...}
})

attach() 绑定表单默认处理逻辑

验证通过时

触发表单提交。

验证未通过时

若规则为 requiredcondRequired 时,对应的输入框获取光标焦点。
其他规则,则使用 alert 进行提示。

data 属性参数

名称说明
data-validation验证规则
data-validation-title项目名称(会在提示内容前填充该内容)
data-validation-message自定义提示消息 [DEMO]设置后会忽略 data-validation-title
<input data-validation="required" data-validation-title="项目名称" data-validation-message="该项为必填">
<!--
验证未通过时 result 对象内容:
{
  status: false,
  message: '【项目名称】该项为必填'
  rule: 'required',
  element: dom
}
-->

data-validation-message 配置

<!-- 所有验证规则都使用相同的提示 -->
<input data-validation="required,minSize[6]" data-validation-message="验证未通过">

<!--
根据验证规则提示
注意:json 格式要求使用双引号,所以外部的需使用单引号
-->
<input data-validation="required,minSize[6]" data-validation-message='{"required":"密码不能为空","minSize":"密码安全性太低,不能少于{{0}}位"}'>

验证规则

验证规则放置在 input, select, textareadata-validation 属性中,如使用多个规则,用 , 分割

<input data-validation="required">
<input data-validation="required,integer">
<input data-validation="required,integer,min[3]">
名称说明
required必填、必选
groupRequiredalias[min]群组必填、必选alias: 群组名称min: 最少填写/选择数量,默认值为 1
condRequiredid[val]依赖必填、必选当依赖控件值有效时,则当前控件为必填id: 控件 id(如依赖多个输入控件,用英文逗号分隔)val: 当控件 id 的值等于 val 时,才为必填(仅限 id 为单个时有效)
equalsid相等验证id: 控件 id
minSizeint最少字符数限制
maxSizeint最多字符数限制
minint最小数值限制
maxint最大数值限制
integer验证整数
number验证数值(正负数、浮点数)
onlyNumber只能填写数字
onlyNumberSp只能填写数字和空格
onlyLetterSp只能填写英文字母和空格
onlyLetterNumber只能填写英文字母和数字
onlyLetterNumberSp只能填写英文字母、数字、空格
email验证电子邮件地址
phone验证电话号码
url验证网址
chinese只能填写中文汉字
chinaId验证身份证号码(仅支持 18 位)
chinaIdLoose验证身份证号码(兼容 18 和 15 位)
chinaZip验证邮政编码
qq验证 QQ 号码
callfunName[agr..]调用自定义函数验证 [DEMO](建议改为使用 setRules 方法)

call 自定义验证方法

<input data-validation="call[myFunction][abc]">
var myFunction = function(el, key) {
  return {
    status: el.value === key,
    message: '请填写 ' + key
  };
};