FormOptions

接口:FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>

定义于: packages/form-core/src/FormApi.ts:238

一个对象,表示表单的选项。

类型参数

TFormData

TOnMount extends undefined | FormValidateOrFn<TFormData>

TOnChange extends undefined | FormValidateOrFn<TFormData>

TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>

TOnBlur extends undefined | FormValidateOrFn<TFormData>

TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>

TOnSubmit extends undefined | FormValidateOrFn<TFormData>

TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>

TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>

TSubmitMeta = never

属性

asyncAlways?

ts
optional asyncAlways: boolean;
optional asyncAlways: boolean;

定义于: packages/form-core/src/FormApi.ts:273

如果为 true,则始终运行异步验证,即使同步验证已产生错误。默认为 undefined。


asyncDebounceMs?

ts
optional asyncDebounceMs: number;
optional asyncDebounceMs: number;

定义于: packages/form-core/src/FormApi.ts:277

可选时间,以毫秒为单位,如果您想在触发异步操作之前引入延迟。


defaultState?

ts
optional defaultState: Partial<FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer>>;
optional defaultState: Partial<FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer>>;

定义于: packages/form-core/src/FormApi.ts:257

表单的默认状态。


defaultValues?

ts
optional defaultValues: TFormData;
optional defaultValues: TFormData;

定义于: packages/form-core/src/FormApi.ts:253

为您的表单设置初始值。


onSubmit()?

ts
optional onSubmit: (props) => any;
optional onSubmit: (props) => any;

定义于: packages/form-core/src/FormApi.ts:300

一个在表单提交时被调用的函数,定义了用户提交有效表单后应该发生什么,返回 any 或 Promise<any>

参数

props
formApi

FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>

meta

TSubmitMeta

value

TFormData

返回值

any


onSubmitInvalid()?

ts
optional onSubmitInvalid: (props) => void;
optional onSubmitInvalid: (props) => void;

定义于: packages/form-core/src/FormApi.ts:319

指定用户尝试提交无效表单时应执行的操作。

参数

props
formApi

FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>

value

TFormData

返回值

void


onSubmitMeta?

ts
optional onSubmitMeta: TSubmitMeta;
optional onSubmitMeta: TSubmitMeta;

定义于: packages/form-core/src/FormApi.ts:295

onSubmitMeta,从 handleSubmit 处理程序传递到 onSubmit 函数 props 的数据


transform?

ts
optional transform: FormTransform<NoInfer<TFormData>, NoInfer<TOnMount>, NoInfer<TOnChange>, NoInfer<TOnChangeAsync>, NoInfer<TOnBlur>, NoInfer<TOnBlurAsync>, NoInfer<TOnSubmit>, NoInfer<TOnSubmitAsync>, NoInfer<TOnServer>, NoInfer<TSubmitMeta>>;
optional transform: FormTransform<NoInfer<TFormData>, NoInfer<TOnMount>, NoInfer<TOnChange>, NoInfer<TOnChangeAsync>, NoInfer<TOnBlur>, NoInfer<TOnBlurAsync>, NoInfer<TOnSubmit>, NoInfer<TOnSubmitAsync>, NoInfer<TOnServer>, NoInfer<TSubmitMeta>>;

定义于: packages/form-core/src/FormApi.ts:334


validators?

ts
optional validators: FormValidators<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync>;
optional validators: FormValidators<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync>;

定义于: packages/form-core/src/FormApi.ts:281

要传递给表单的验证器列表

订阅 Bytes

您的每周 JavaScript 新闻。每周一免费发送给超过 100,000 名开发者。

Bytes

无垃圾邮件。随时取消订阅。