FormOptions

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

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

表示表单选项的对象。

类型参数

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:357

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


asyncDebounceMs?

ts
optional asyncDebounceMs: number;
optional asyncDebounceMs: number;

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

可选的毫秒数,如果您想在触发异步操作之前引入延迟。


canSubmitWhenInvalid?

ts
optional canSubmitWhenInvalid: boolean;
optional canSubmitWhenInvalid: boolean;

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

如果为 true,则允许在无效状态下提交表单,即无论校验错误如何,canSubmit 都将保持为 true。默认为 undefined。


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:341

表单的默认状态。


defaultValues?

ts
optional defaultValues: TFormData;
optional defaultValues: TFormData;

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

为表单设置初始值。


listeners?

ts
optional listeners: FormListeners<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>;
optional listeners: FormListeners<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>;

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

表单级侦听器


onSubmit()?

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

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

表单提交时调用的函数,用户提交有效表单后应发生什么,返回 any 或 promise 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:423

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

参数

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:383

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:438


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:369

传递给表单的校验器列表。