表单校验
我们推荐使用schema-typed对表单数据进行管理和校验。在 rsuite 中默认集成了 schema-typed,可以通过 Schema 对象来定义表的数据模型。它可以帮助我们定义数据模型,校验数据,以及生成错误信息。
使用
导入 Form 与 Schema
import { Form } from 'rsuite';
import { SchemaModel, StringType } from 'rsuite/Schema';通过 SchemaModel 定义数据模型
const model = SchemaModel({
name: StringType().isRequired('This field is required.'),
email: StringType().isEmail('Please enter a valid email address.')
});为 Form 设置 model
const TextField = ({ name, label, accepter, ...rest }) => (
<Form.Group controlId={name}>
<Form.Label>{label} </Form.Label>
<Form.Control name={name} accepter={accepter} {...rest} />
</Form.Group>
);
return (
<Form model={model}>
<TextField name="name" label="Username" />
<TextField name="email" label="Email" />
<Button appearance="primary" type="submit">
Submit
</Button>
</Form>
);演示
默认校验
在表单触发了 submit 事件后,会自动触发数据检查。
数据模型
表单校验需要用到 <Form>, <Form.Control> 组件, 和 Schema 。
<Form>定义一个表单,可以给表单设置formValue和model,model是由SchemaModel创建的数据模型。<Form.Control>定义一个 Field ,通过name属性和SchemaModel对象的key对应, 详细参考: 自定义表单组件。SchemaModel定义一个数据模型,详细使用参考 schema。- 自定义触发校验:
<Form>实例提供 check() 与 checkForField() 方法,分别用于触发表单校验和字段校验。
Field 级别的校验规则
当 Field 越来越多时,会产生庞大的model代码或文件,并且由于在定义在顶层,不够灵活(例如:一个字段的新增和删除,通常还需要在顶层对model进行操作)。
这时,Field 级别的校验规则可能是更好的选择,它在组件挂载时添加,组件卸载时删除。
<Form.Control>通过rule属性支持添加当前 Field 的校验规则。
异步校验
在某些条件下,我们需对数据进行异步校验,比如校验用户名是否重名,下面一个示例将说明异步校验的处理。
- 在需要异步校验的
<Form.Control>上设置checkAsync属性。 - 异步校验的验证规则通过
schema的addRule方法添加一个返回值为 Promise 的对象。 - 通过调用
<Form>的checkAsync与checkForFieldAsync的访问,可以手动触发校验。
表单输入组件
所有的 Data Entry 相关的组件都可以在表单中使用。 需要通过 Form.Control 组件进行数据管理,实现与 Form 组件的数据关联。
- Form.Control 用于绑定 Form 中的数据字段,通过
name属性和 SchemaModel 对象的key对应。 - Form.Control 默认是个
Input组件,可以通过accepter设置需要的数据录入组件。
与第三方 input 库的整合
有时候需要额外开发自定义的表单输入组件或者兼容第三方组件,例如 react-select。
自定义触发校验
在某些情况下不需要对表单数据进行实时校验,可以自定义控制校验的方式,配置 checkTrigger 参数。
checkTrigger 默认值是 'change', 选项包括:
'change': 数据改变onChange的时候会触发数据校验。'blur': 组件失去焦点触发校验'none': 不触发校验,只会在调用<Form>的check()方法的时候才会校验
在 <Form> 和 <Form.Control> 组件上都有 checkTrigger 属性, 在 <Form> 中可以定义整个表单的校验方式,如果有个表单组件需要单独处理校验方式,可以在 <Form.Control> 上进行设置。
动态表单校验
表单数据嵌套
代理校验
注意:当
Form启用nestedField时,不支持proxy。
使用 useFormControl 创建自定义表单字段
useFormControl hook 允许您创建与表单验证系统无缝集成的自定义表单字段。这种方法使您可以完全控制表单字段的 UI,同时保持所有验证功能。