> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.
# 表单校验
> 梳理宜搭表单校验能力，包括各表单组件的内置校验规则与自定义校验函数写法，保障提交数据的规范性。
表单场景是宜搭最为常用的场景，我们在使用表单时经常会需要进行表单项的校验工作，宜搭平台除了为不同表单项组件提供一些内置的常见校验规则还提供了自定义表单项校验的能力，帮助用户更好的管理表单数据，避免脏数据的提交。
当用户的提交的数据没有通过校验规则，则会在表单项下方展示错误信息并阻止用户提交表单数据，效果如下所示：
## 校验设置
宜搭平台提供两种表单设置方案，其设置方案分别如下所示：
### 内置校验规则
宜搭平台为每个表单组件都内置了一些常用的校验规则，用户只要通过简单的设置并启用该规则就可以了，例如上面的最小年纪设置，我们通过如下配置便可轻松实现：
### 自定义校验规则
宜搭内置的表单项校验方法难免会有覆盖不到的情况，因此宜搭还为每个表单项组件增加了一个自定义规则设置的方案，通过函数来控制表单校验结果，自定义校验规则的函数描述如下所示：
```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
// value 为表单项当前的值，返回boolean类型判断校验是否通过
function validateRule(value: any): boolean;
```
例如我们需要校验一个文本输入框的内容是否以 "杭州开头"，可以通过如下方式：
```js theme={"theme":{"light":"github-light","dark":"github-dark"}}
// 是否以”杭州”开头
function validateRule(value) {
if (/^杭州/.test(value)) {
return true;
}
return false;
```
## API
表单校验除了在表单提交的时候进行校验，还能够通过[前端API](/zh/open/yida/api/yidaAPI#thisfieldidvalidate)进行手动触发，如下所示：
```js theme={"theme":{"light":"github-light","dark":"github-dark"}}
export function validate() {
// 执行输入框组件的校验，如果校验失败则在 console 中打印 errors 和 values
this.$('textField_kyz78exp').validate((errors, values) => {
console.log(JSON.stringify({errors, values}, null, 2));
});
}
```
## 常用自定义校验
### 银行卡号校验
#### 卡号长度校验
卡号为 16 位数或 19 位数
```js theme={"theme":{"light":"github-light","dark":"github-dark"}}
function validateRule(value) {
return value && /^([0-9]{16}|[0-9]{19})$/.test(value);
}
```
#### 卡号校验
使用 [**Luhn 算法**](https://baike.baidu.com/item/Luhn%E7%AE%97%E6%B3%95/22799984) 校验
```js theme={"theme":{"light":"github-light","dark":"github-dark"}}
function validateRule(value) {
if (value && /^([0-9]{16}|[0-9]{19})$/.test(value)) {
let total = 0;
value.split('').reverse().forEach((item, idx) => {
const num = parseInt(item, 10);
total += idx % 2 ? 2 * num - (num > 4 ? 9 : 0) : num;
});
if (total === 0) {
return false;
}
return total % 10 === 0;
}
return false;
}
```
### 身份证号校验
```js theme={"theme":{"light":"github-light","dark":"github-dark"}}
function validateRule(value) {
if (value && value.length === 18) {
const coeff = [7, 9, 10, 5, 8, 4, 2, 1, 6, 3, 7, 9, 10, 5, 8, 4, 2];
const laststr = ['1', '0', 'X', '9', '8', '7', '6', '5', '4', '3', '2'];
let total = 0;
for(let i = 0; i < 17; ++ i) {
total+= parseInt(value[i], 10) * coeff[i];
}
return value[17] === laststr[total % 11];
}
return false;
}
```