Recommended Types
Form Composition API Reference
FormApi Reference
- form.setFieldValue()
- form.getFieldValue()
- form.resetField()
- form.swapFieldValues()
- form.moveFieldValue()
- form.pushFieldValue()
- form.insertFieldValue()
- form.clearFieldValues()
- form.removeFieldValue()
- form.filterFieldValues()
- form.handleSubmit()
- form.reset()
- FormApi
- FormOptions
- FormState
- FormResetOptions
- FormSubmitContext
- FormSubmitInvalidContext
Form Listener API Reference
Field Listener API Reference
FormOptionsLooseSchemaFn
type FormOptionsLooseSchemaFn<TPayload> = <TSchema, TFormData, TValidatorConfig, TValidators, TSubmitReturn>(schema, options) => InferredFormOptions<InferUnion<TFormData, StandardSchemaInput<TSchema>>, TValidators, TSubmitReturn, TPayload>;Defined in: FormApi/formOptions.public.ts:304
Function type for creating form options from a Standard Schema with defaults that may omit properties or contain null or undefined.
Type Parameters#
TPayload#
TPayload
Library-managed. Do not specify explicitly.
Type Parameters#
TSchema#
TSchema extends StandardSchemaV1<any, any>
Library-managed. Do not specify explicitly.
TFormData#
TFormData extends Editable<StandardSchemaInput<TSchema>>
Library-managed. Do not specify explicitly.
TValidatorConfig#
TValidatorConfig extends unknown[]
Library-managed. Do not specify explicitly.
TValidators#
TValidators
Library-managed. Do not specify explicitly.
TSubmitReturn#
TSubmitReturn
Library-managed. Do not specify explicitly.
Parameters#
schema#
TSchema
options#
LooseSchemaFormOptions<StandardSchemaInput<TSchema>, TFormData, TValidatorConfig, TValidators, TSubmitReturn>
Returns#
InferredFormOptions<InferUnion<TFormData, StandardSchemaInput<TSchema>>, TValidators, TSubmitReturn, TPayload>
The supplied options object unchanged.