Rx Form State
Edit page
开始
教程
API
useFormStateFormStateContextFieldFieldArrayFormValueMonitoruseFormStateContextuseFormSelectuseFormSubmittinguseFielduseField 返回的属性和方法关联useFieldStateuseFieldErroruseFieldValueuseFieldToucheduseFieldArrayRelyRule

useField

获取表单域状态和设置表单域状态方法的 hook。

imoprt { useField } from '@sinoui/rx-form-state';
function FieldDemo() {
const field = useField('userName');
// ...
}

useField 返回的属性和方法

属性或方法类型描述
namestring表单域名称
valueT表单域的值
error`stringnull`
asyncError`stringnull`
isTouchedboolean表单域被操作过的状态
isPendingboolean异步校验中状态
formStateFormState表单状态管理器对象
addField(fieldConfig: fieldConfig) => void向 formState 添加表单域配置
removeField() => void从 formState 中移除表单域配置
setFieldValue(value: T) => void设置表单域的值。
blur() => void表单域失去焦点的回调函数。
validateField() => void验证表单域。
setFieldState(producer: (draft: FieldStateModel<T>) => void) => FieldStateModel<T>设置表单域的状态。
setFieldTouched(isTouched?: boolean) => void设置表单域的被操作状态。
setError(error?: string) => void设置表单域的验证错误。
setAsyncError(asyncError?: string) => void设置异步校验错误。
setFieldPending(isPending: boolean) => void设置表单域异步校验中状态。

关联

  • useFieldState
  • Field
  • useFieldError
  • useFieldValue
  • api-use-field-touched