Form Docs
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
AI/LLM: This documentation page is available in plain markdown format at/form/alpha/docs/reference/variables/formOptions.md
Form creation
formOptions
ts
const formOptions: FormOptionsApi<unknown>;Defined in: FormApi/formOptions.public.ts:415
Defines reusable form options with inferred values, validators, and callback types.
Returns the supplied object unchanged. Pass the result to a framework adapter's form creation API to create a form.
Example#
ts
const profileOptions = formOptions({
defaultValues: { name: '' },
validators: [
{
triggers: ['blur'],
run: ({ value }) => (value.name.trim() ? undefined : 'Enter a name'),
},
],
})