arthur/ui
1
0
Fork 0
mirror of https://github.com/ArthurDanjou/ui.git synced 2026-02-03 05:37:56 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs(Form): clarify when the @error event is triggered (#1747)

Browse Source
This commit is contained in:
Romain Hamel
2024-05-06 10:39:05 +02:00
committed by GitHub
parent 7e6ba78681
commit f97b728968
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/content/2.components/form.md
View File

@@ -63,7 +63,7 @@ The validation function must return a list of errors with the following attribut
- `path` - Path to the form element corresponding to the `name` attribute. - `path` - Path to the form element corresponding to the `name` attribute.
::callout{icon="i-heroicons-light-bulb"} ::callout{icon="i-heroicons-light-bulb"}
Note: this can be used alongside the `schema` prop to handle complex use cases. Note that it can be used alongside the `schema` prop to handle complex use cases.
:: ::
::component-example ::component-example
@@ -184,13 +184,13 @@ Take a look at the component!
## Error event ## Error event
You can listen to the `@error` event to handle errors. This event is triggered when the form is validated and contains an array of `FormError` objects with the following fields: You can listen to the `@error` event to handle errors. This event is triggered when the form is submitted and contains an array of `FormError` objects with the following fields:
- `id` - the identifier of the form element. - `id` - the identifier of the form element.
- `path` - the path to the form element matching the `name`. - `path` - the path to the form element matching the `name`.
- `message` - the error message to display. - `message` - the error message to display.
Here is an example of how to focus the first form element with an error: Here's an example that focuses the first input element with an error after the form is submitted:
::component-example ::component-example
--- ---