--- description: A form element that provides validation and submission handling. links: - label: GitHub icon: i-simple-icons-github to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Form.vue navigation: badge: label: Todo --- ## Usage ## Examples ## API ### Props :component-props ### Slots :component-slots ### Emits :component-emits ### Expose When accessing the component via a template ref, you can use the following: | Name | Type | | ---- | ---- | | `submit()`{lang="ts-type"} | `Promise`{lang="ts-type"}

Triggers form submission.

| | `validate(path?: string \| string[], opts: { silent?: boolean })`{lang="ts-type"} | `Promise`{lang="ts-type"}

Triggers form validation. Will raise any errors unless `opts.silent` is set to true.

| | `clear(path?: string)`{lang="ts-type"} | `void`

Clears form errors associated with a specific path. If no path is provided, clears all form errors.

| | `getErrors(path?: string)`{lang="ts-type"} | `FormError[]`{lang="ts-type"}

Retrieves form errors associated with a specific path. If no path is provided, returns all form errors.

| | `setErrors(errors: FormError[], path?: string)`{lang="ts-type"} | `void`

Sets form errors for a given path. If no path is provided, overrides all errors.

| | `errors`{lang="ts-type"} | `Ref`{lang="ts-type"}

A reference to the array containing validation errors. Use this to access or manipulate the error information.

| | `disabled`{lang="ts-type"} | `Ref`{lang="ts-type"} |