arthur/ui
1
0
Fork 0
mirror of https://github.com/ArthurDanjou/ui.git synced 2026-01-31 20:28:09 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs(form): improve API section

Browse Source
This commit is contained in:
Benjamin Canac
2024-01-23 11:50:09 +01:00
parent ea9807f921
commit a47d9cc006
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/content/3.forms/10.form.md
View File

@@ -202,6 +202,8 @@ componentProps:
## API ## API
When accessing the component via a template ref, you can use the following:
::field-group ::field-group
::field{name="submit ()" type="Promise<void>"} ::field{name="submit ()" type="Promise<void>"}
Triggers form submission. Triggers form submission.
@@ -209,16 +211,16 @@ componentProps:
::field{name="validate (path?: string, opts: { silent?: boolean })" type="Promise<T>"} ::field{name="validate (path?: string, opts: { silent?: boolean })" type="Promise<T>"}
Triggers form validation. Will raise any errors unless `opts.silent` is set to true. Triggers form validation. Will raise any errors unless `opts.silent` is set to true.
:: ::
::field{name="clear (path?: string)" type="void"} ::field{name="clear (path?: string)"}
Clears form errors associated with a specific path. If no path is provided, clears all form errors. Clears form errors associated with a specific path. If no path is provided, clears all form errors.
:: ::
::field{name="getErrors (path?: string)" type="FormError[]"} ::field{name="getErrors (path?: string)" type="FormError[]"}
Retrieves form errors associated with a specific path. If no path is provided, returns all form errors. Retrieves form errors associated with a specific path. If no path is provided, returns all form errors.
:: ::
::field{name="setErrors (errors: FormError[], path?: string)" type="void"} ::field{name="setErrors (errors: FormError[], path?: string)"}
Sets form errors for a given path. If no path is provided, overrides all errors. Sets form errors for a given path. If no path is provided, overrides all errors.
:: ::
::field{name="errors" type="Ref<FormError[]>"} ::field{name="errors" type="Ref<FormError[]>"}
A reference to the array containing validation errors. Use this to access or manipulate the error information. A reference to the array containing validation errors. Use this to access or manipulate the error information.
:: ::
:: ::