函数: createFormHook()

function createFormHook<TComponents, TFormComponents>(__namedParameters): object

function createFormHook<TComponents, TFormComponents>(__namedParameters): object

定义于: packages/react-form/src/createFormHook.tsx:284

类型参数

• TComponents 继承自 Record<string, ComponentType<any>>

• TFormComponents 继承自 Record<string, ComponentType<any>>

参数

__namedParameters

CreateFormHookProps<TComponents, TFormComponents>

Returns (返回)

object

useAppForm()

useAppForm: <TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>(props) => AppFieldExtendedReactFormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta, TComponents, TFormComponents>;

useAppForm: <TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>(props) => AppFieldExtendedReactFormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta, TComponents, TFormComponents>;

类型参数

• 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

参数

props

FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>

AppFieldExtendedReactFormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta, TComponents, TFormComponents>

withFieldGroup()

withFieldGroup: <TFieldGroupData, TSubmitMeta, TRenderProps>(__namedParameters) => <TFormData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TFormSubmitMeta>(params) => Element;

withFieldGroup: <TFieldGroupData, TSubmitMeta, TRenderProps>(__namedParameters) => <TFormData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TFormSubmitMeta>(params) => Element;

类型参数

• TFieldGroupData

• TSubmitMeta

• TRenderProps 继承自 Record<string, unknown> = {}

参数

__namedParameters

WithFieldGroupProps<TFieldGroupData, TComponents, TFormComponents, TSubmitMeta, TRenderProps>

Returns (返回)

Function

类型参数

• TFormData

• TFields 继承自 | string | { [K in string | number | symbol]: DeepKeysOfType<TFormData, TFieldGroupData[K]> }

• 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>

• TFormSubmitMeta

参数

params

PropsWithChildren<NoInfer<TRenderProps> & object>

Returns (返回)

Element

withForm()

withForm: <TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta, TRenderProps>(__namedParameters) => (props) => Element;

withForm: <TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta, TRenderProps>(__namedParameters) => (props) => Element;

类型参数

• 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

• TRenderProps 继承自 object = {}

参数

__namedParameters

WithFormProps<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta, TComponents, TFormComponents, TRenderProps>