Skip to content

Commit 8c25577

Browse files
aweiuaweiu
committed
更新文档
1 parent 56170ef commit 8c25577

File tree

3 files changed

+11
-287
lines changed

3 files changed

+11
-287
lines changed

‎.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Created by .ignore support plugin (hsz.mobi)
22
node_modules
33
dev/dist
4-
dev/babel-all.js
4+
dev/babel-all.js
5+
.idea

‎README.md

Lines changed: 8 additions & 285 deletions
Original file line numberDiff line numberDiff line change
@@ -1,298 +1,21 @@
11
# vue-verify-pop
2-
自带气泡提示的vue校验插件
32

4-
## 安装
5-
```
6-
npm install vue-verify-pop
7-
```
8-
## 使用
9-
**VUE版本：1.x** <br>
10-
**必须在vue-cli生成的webpack模板环境中使用**
11-
### 一，在./main.js中执行全局配置
12-
```
13-
import vue from 'vue'
14-
import verify from 'vue-verify-pop'
15-
vue.use(verify)
16-
// 以下配置非必须，按你的需求来
17-
// 配置默认校验不通过时的提示信息
18-
verify.errMsg = YourErroMsg
19-
// 增加校验规则
20-
verify.addRule('myRule', (v) => {return '校验不通过'})
21-
```
22-
### 二，在表单元素中配置校验规则
3+
自带气泡提示的 vue 校验插件
4+
5+
## 示例
6+
237
```
248
<!--待校验元素的pop容器-->
259
<pop>
2610
<!--该输入框内容为最多为两位小数的数字-->
2711
<input v-verify decimal-length="2">
2812
</pop>
2913
```
30-
![image](https://github.com/aweiu/vue-verify-pop/raw/master/example.png)
31-
32-
ok，您已经完成了一个基础校验。气泡提示怎么样？丑的话自己用css改吧。。<br>
33-
*当输入框失去焦点时会自动触发校验，如果校验不通过会出现气泡。再次输入气泡会消失*
3414

35-
## 支持的校验规则(继承verify-base.js)
36-
* length: 校验文本长度
37-
* minLength: 校验文本最短长度
38-
* maxLength: 校验文本最长长度
39-
* maxNumber: 校验数字最大值
40-
* minNumber: 校验数字最小值
41-
* decimalLength: 校验小数位
42-
* number: 校验是否为数字
43-
* int: 校验是否为整数
44-
* phone: 校验是否为手机号
45-
* idCard: 校验是否为身份证号
46-
* bankCard: 校验是否为银行卡号
47-
* email: 校验是否为电子邮件地址
48-
* verifyCode: 校验是否为6位数字验证码
49-
* canBeNull: 当参数为空时跳过校验，不会执行后面的校验规则(注意：自定义校验函数'verify'仍然会执行)
15+
![image](https://github.com/aweiu/vue-verify-pop/raw/master/example.png)
5016

51-
## 重要参数说明
52-
**注意：规则中不能有大写字母，用中划线分隔，同vue props属性设置规则**
53-
### errMsg
54-
用于自定义校验不通过提示
55-
```
56-
<pop>
57-
<input v-verify length="10" err-msg="请输入正确的卡号">
58-
</pop>
59-
```
60-
### maxNumber
61-
注意小于和小于等于的写法
62-
```
63-
<!--该输入框内容必须为小于等于10的数字-->
64-
<pop>
65-
<input v-verify max-number="10">
66-
</pop>
67-
<!--该输入框内容必须为小于10的数字,通过'!'来标识-->
68-
<pop>
69-
<input v-verify max-number="!10">
70-
</pop>
71-
```
72-
### minNumber
73-
参考**maxNumber**配置
17+
ok，您已经完成了一个基础校验。气泡提示怎么样？丑的话自己用 css 改吧。。
7418

75-
### pop
76-
用于设置气泡组件的位置。<br>
77-
默认情况下，插件会查找待校验元素的分发对象或父容器(父容器的父容器的父容器...)是否为pop组件，如果找到则使用之。<br>
78-
当待校验元素和气泡提示不再满足父子容器关系时，可以用如下方式去指定：
79-
```
80-
<!--当校验不通过时，气泡提示会出现在这个div上面-->
81-
<pop id="cardIdPop">
82-
<div>我是一个div</div>
83-
</pop>
84-
<input v-verify length="10" err-msg="卡号不正确" pop="cardIdPop">
85-
```
86-
### noCache
87-
用于禁止插件对校验结果的缓存。默认情况下，插件会缓存上次的校验结果，直到待校验元素的值发生变化
88-
```
89-
<pop>
90-
<input v-verify length="10" err-msg="卡号不正确" no-cache>
91-
</pop>
92-
```
93-
### canBeNull
94-
**插件默认校验输入内容不为空**，该参数一般用于如下情况，比如邀请码这种一般可以为空，不为空又需要校验的输入项
19+
## 文档
9520

96-
自定义校验方法**verify**始终会执行，主要考虑到该校验方法中的校验对象很可能不仅仅是输入框本身的值，故不应受该配置项的影响
97-
```
98-
<!--当邀请码不为空时才校验长度是否等于10-->
99-
<pop>
100-
<input v-verify length="10" err-msg="邀请码不正确" can-be-null>
101-
</pop>
102-
```
103-
### watch
104-
监听其他变量，触发自身校验。<br>
105-
一个常见例子:最少参与人数不能大于最多参与人数，当最少参与人数变化时应当触发最多参与人数的校验
106-
```
107-
<template>
108-
<pop>
109-
<input placeholder="最少参与人数" v-verify v-model="minNumber" v-verify int>
110-
</pop>
111-
<pop>
112-
<input placeholder="最多参与人数" v-verify v-model="minNumber" v-verify int :verify="verifyMaxNumber" :watch="minNumber">
113-
</pop>
114-
</template>
115-
<script>
116-
export default{
117-
data () {
118-
return {
119-
minNumber: ''
120-
}
121-
},
122-
methods: {
123-
verifyMaxNumber (val) {
124-
if (val - this.minNumber < 0) return '最多参与人数不能小于最少参与人数'
125-
}
126-
}
127-
}
128-
</script>
129-
```
130-
## 规则简写
131-
number/int/phone等无须设定值的规则可以直接：
132-
```
133-
<pop>
134-
<!--该输入框内容必须为手机号-->
135-
<input v-verify phone>
136-
</pop>
137-
```
138-
maxNumber/minNumber/decimalLength无须写number规则
139-
```
140-
<pop>
141-
<!--该输入框内容必须为不大于10的数字-->
142-
<input v-verify max-number="10">
143-
<!--不用这么写-->
144-
<input v-verify number max-number="10">
145-
</pop>
146-
```
147-
## 自定义校验方法
148-
如果自带的校验方法满足不了您的需求，可以在校验规则中插入您自己的校验方法
149-
```
150-
<template>
151-
<pop>
152-
<!--通过给props.verify赋值来植入自定义校验-->
153-
<!--当length规则通过时才会执行自定义校验-->
154-
<input v-verify length="10" :verify="verifyCardId" err-msg="卡号不正确">
155-
</pop>
156-
</template>
157-
<script>
158-
export default{
159-
methods: {
160-
verifyCardId (val) {
161-
// val: 待校验的值
162-
// 可以直接return校验不通过的提示
163-
// if (val.substr(0,1) !== '0') return '卡号不正确'
164-
// 如果直接return true/false 校验不通过提示将使用errMsg或默认错误提示
165-
// return val.substr(0,1) === '0'
166-
}
167-
}
168-
}
169-
</script>
170-
```
171-
## 自定义校验规则
172-
和自定义校验方法的区别是这个适用于全局，等于增加插件自带的校验规则
173-
```
174-
// 新增校验是否为6位数字 val: 待校验的值 rule: 规则值。
175-
// 校验是否为6位数字这种一般时不需要额外参数用来对比,所以rule参数用不到。校验文本长度，数字大小这种才会用到rule
176-
// <input v-verify length="6"> '6'会作为rule参数
177-
var verifyBase = verify.verifyBase
178-
verify.addRule('number6', (val, rule) => {
179-
// 判断是否为6位数字
180-
// 只需要关注错误的情况 返回默认出错提示即可
181-
if (!verifyBase('number')(val).valid || !verifyBase('length')(val, 6)) return '请输入正确的6位数字'
182-
})
183-
```
184-
调用
185-
```
186-
<!--校验不通过提示优先errMsg,然后才是您自定义规则中返回的默认出错提示-->
187-
<input v-verify number6 err-msg="请输入正确的6位数字验证码">
188-
```
189-
## 手动触发校验&分组校验
190-
```
191-
<template>
192-
<pop>
193-
<!--给目标元素设置v-el-->
194-
<input v-verify length="10" err-msg="卡号1不正确" v-el:ipt>
195-
</pop>
196-
<pop>
197-
<!--给目标元素设置id-->
198-
<input v-verify length="10" err-msg="卡号2不正确" id="ipt">
199-
</pop>
200-
<!--给目标元素设置组名-->
201-
<verify name="verifyGroup">
202-
<pop>
203-
<input v-verify length="10" err-msg="卡号3不正确">
204-
</pop>
205-
<pop>
206-
<input v-verify length="10" err-msg="卡号4不正确">
207-
</pop>
208-
</verify>
209-
</template>
210-
<script>
211-
export default{
212-
ready () {
213-
// 调用vm对象中$verify方法
214-
// 无参调用会触发当前vm中所有的待校验元素执行校验并显示校验气泡
215-
this.$verify()
216-
// 通过传id参数('#'+id)触发输入框的校验并显示校验气泡
217-
this.$verify('#ipt')
218-
// 通过传dom元素触发输入框的校验并显示校验气泡
219-
this.$verify(this.$els.ipt)
220-
// 通过传校验组名来校验该组的所有待校验元素
221-
this.$verify('verifyGroup')
222-
// 只校验，不显示校验气泡
223-
this.$verify('verifyGroup', false)
224-
// 返回：
225-
{
226-
// 所有校验结果是否都通过
227-
valid: true/false,
228-
results: [
229-
{
230-
// 校验的dom元素
231-
el: DOM,
232-
// 该元素校验是否通过
233-
valid: true/false,
234-
// 错误信息
235-
msg: ''
236-
}
237-
]
238-
}
239-
}
240-
}
241-
</script>
242-
```
243-
## 插件的默认校验不通过提示模版
244-
```
245-
{
246-
number: {
247-
common: '请输入数字',
248-
// >
249-
maxNumber: '该输入框数字不能大于{maxNumber}',
250-
// >=
251-
maxNumber2: '该输入框数字应小于{maxNumber}',
252-
// <
253-
minNumber: '该输入框数字不能小于{minNumber}',
254-
// <=
255-
minNumber2: '该输入框数字应大于{minNumber}',
256-
decimalLength: '该输入框最多接受{decimalLength}位小数'
257-
},
258-
// 特殊类型
259-
int: '该输入框仅接受整数',
260-
phone: '请输入正确的手机号',
261-
idCard: '请输入正确的身份证号',
262-
bankCard: '请输入正确的银行卡号',
263-
email: '请输入正确的邮箱',
264-
verifyCode: '请输入正确的验证码',
265-
common: {
266-
empty: '请补充该项内容',
267-
length: '请输入{length}位字符',
268-
minLength: '该输入框内容至少{minLength}位'
269-
},
270-
specialInput: {
271-
checkbox: '请勾选我'
272-
}
273-
}
274-
```
275-
您可以按照上述格式自定义您的错误提示
276-
```
277-
verify.errMsg = {}
278-
```
279-
也可以只修改某些项
280-
```
281-
verify.errMsg.int = '{mark}必须为整数'
282-
```
283-
## 彩蛋
284-
校验插件不仅能检测到输入内容的变化，绑定值的变化同样在掌控之内，也就是说校验气泡的出现和消失您完全无须手动控制
285-
```
286-
<!--当卡号输入框出校验气泡提示时，cardId值的变化或重新输入卡号，气泡提示都会消失-->
287-
<pop>
288-
<input v-model="cardId" v-verify length="10" err-msg="卡号不正确">
289-
</pop>
290-
```
291-
### pop
292-
本插件的气泡提示来自[vue-pop](https://github.com/aweiu/vue-pop)，有关气泡提示的设置请参考该文档
293-
### verifyBase
294-
本插件校验的核心方法来自[verify-base](https://github.com/aweiu/verify-base)
295-
```
296-
// 通过该方式获取verifyBase以使用其内置的各种校验方法
297-
verify.verifyBase
298-
```
21+
https://aweiu.com/documents/vue-verify-pop/

‎package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "vue-verify-pop",
3-
"version": "0.1.5",
3+
"version": "0.1.6",
44
"description": "自带气泡提示的vue校验插件",
55
"keywords": [
66
"verify",

0 commit comments

Comments
 (0)