ui/docs/content/3.components/form.md

description, links

description	links
Collect and validate form data.	label icon to GitHub i-simple-icons-github https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Form.vue

Usage

Examples

API

Props

:component-props

Slots

:component-slots

Events

:component-events

Exposed

When accessing the component via a template ref, you can use the following:

Name	Type
submit(){lang="ts-type"}	Promise<void>{lang="ts-type"} Triggers form submission.
validate(path?: string | string[], opts: { silent?: boolean }){lang="ts-type"}	Promise<T>{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<FormError[]>{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<boolean>{lang="ts-type"}