在此页面
- Interface: FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>
- 继承自
- 类型参数
- 属性
- asyncAlways?
- asyncDebounceMs?
- canSubmitWhenInvalid?
- defaultState?
- defaultValues?
- 继承自
- formId?
- listeners?
- onSubmit()?
- 参数
- props
- formApi
- meta
- value
- Returns (返回)
- onSubmitInvalid()?
- 参数
- props
- formApi
- meta
- value
- Returns (返回)
- onSubmitMeta?
- 继承自
- transform?
- validationLogic?
- validators?
FormOptions
Interface: FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>
定义于: packages/form-core/src/FormApi.ts:369
表示表单选项的对象。
继承自
- BaseFormOptions<TFormData, TSubmitMeta>
类型参数
• TFormData
• TOnMount 继承自 undefined | FormValidateOrFn<TFormData>
• TOnChange 继承自 undefined | FormValidateOrFn<TFormData>
• TOnChangeAsync 继承自 undefined | FormAsyncValidateOrFn<TFormData>
• TOnBlur 继承自 undefined | FormValidateOrFn<TFormData>
• TOnBlurAsync 继承自 undefined | FormAsyncValidateOrFn<TFormData>
• TOnSubmit 继承自 undefined | FormValidateOrFn<TFormData>
• TOnSubmitAsync 继承自 undefined | FormAsyncValidateOrFn<TFormData>
• TOnDynamic 继承自 undefined | FormValidateOrFn<TFormData>
• TOnDynamicAsync 继承自 undefined | FormAsyncValidateOrFn<TFormData>
• TOnServer 继承自 undefined | FormAsyncValidateOrFn<TFormData>
• TSubmitMeta = never
属性
asyncAlways?
optional asyncAlways: boolean;
optional asyncAlways: boolean;
定义于: packages/form-core/src/FormApi.ts:408
如果为 true，始终运行异步验证，即使同步验证已产生错误。默认为 undefined。
asyncDebounceMs?
optional asyncDebounceMs: number;
optional asyncDebounceMs: number;
定义于: packages/form-core/src/FormApi.ts:412
可选的毫秒数，如果您想在触发异步操作之前引入延迟。
canSubmitWhenInvalid?
optional canSubmitWhenInvalid: boolean;
optional canSubmitWhenInvalid: boolean;
定义于: packages/form-core/src/FormApi.ts:416
如果为 true，允许表单在无效状态下提交，即无论验证错误如何，canSubmit 都会保持 true。默认为 undefined。
defaultState?
optional defaultState: Partial<FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>>;
optional defaultState: Partial<FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>>;
定义于: packages/form-core/src/FormApi.ts:390
表单的默认状态。
defaultValues?
optional defaultValues: TFormData;
optional defaultValues: TFormData;
定义于: packages/form-core/src/FormApi.ts:359
设置表单的初始值。
继承自
formId?
optional formId: string;
optional formId: string;
定义于: packages/form-core/src/FormApi.ts:386
表单名称，用于开发者工具和标识
listeners?
optional listeners: FormListeners<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>;
optional listeners: FormListeners<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>;
定义于: packages/form-core/src/FormApi.ts:438
表单级监听器
onSubmit()?
optional onSubmit: (props) => any;
optional onSubmit: (props) => any;
定义于: packages/form-core/src/FormApi.ts:456
当表单提交时调用的函数，当用户提交一个有效表单时应该做什么，返回 any 或一个 Promise Promise<any>
参数
props
formApi
FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>
meta
TSubmitMeta
value
TFormData
Returns (返回)
any
onSubmitInvalid()?
optional onSubmitInvalid: (props) => void;
optional onSubmitInvalid: (props) => void;
定义于: packages/form-core/src/FormApi.ts:477
为用户尝试提交无效表单的场景指定一个操作。
参数
props
formApi
FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>
meta
TSubmitMeta
value
TFormData
Returns (返回)
void
onSubmitMeta?
optional onSubmitMeta: TSubmitMeta;
optional onSubmitMeta: TSubmitMeta;
定义于: packages/form-core/src/FormApi.ts:363
onSubmitMeta，从 handleSubmit 处理程序传递到 onSubmit 函数 props 的数据
继承自
transform?
optional transform: FormTransform<NoInfer<TFormData>, NoInfer<TOnMount>, NoInfer<TOnChange>, NoInfer<TOnChangeAsync>, NoInfer<TOnBlur>, NoInfer<TOnBlurAsync>, NoInfer<TOnSubmit>, NoInfer<TOnSubmitAsync>, NoInfer<TOnDynamic>, NoInfer<TOnDynamicAsync>, NoInfer<TOnServer>, NoInfer<TSubmitMeta>>;
optional transform: FormTransform<NoInfer<TFormData>, NoInfer<TOnMount>, NoInfer<TOnChange>, NoInfer<TOnChangeAsync>, NoInfer<TOnBlur>, NoInfer<TOnBlurAsync>, NoInfer<TOnSubmit>, NoInfer<TOnSubmitAsync>, NoInfer<TOnDynamic>, NoInfer<TOnDynamicAsync>, NoInfer<TOnServer>, NoInfer<TSubmitMeta>>;
定义于: packages/form-core/src/FormApi.ts:495
validationLogic?
optional validationLogic: ValidationLogicFn;
optional validationLogic: ValidationLogicFn;
定义于: packages/form-core/src/FormApi.ts:433
validators?
optional validators: FormValidators<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>;
optional validators: FormValidators<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>;
定义于: packages/form-core/src/FormApi.ts:420
要传递给表单的验证器列表
订阅 Bytes
您的每周 JavaScript 资讯。每周一免费发送给超过 10 万开发者。
订阅 Bytes
您的每周 JavaScript 资讯。每周一免费发送给超过 10 万开发者。