Skip to content

Commit

Permalink
docs(Form): clarify when the @error event is triggered (#1747)
Browse files Browse the repository at this point in the history
  • Loading branch information
romhml committed May 6, 2024
1 parent 7e6ba78 commit f97b728
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/content/2.components/form.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

::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
Expand Down Expand Up @@ -184,13 +184,13 @@ Take a look at the component!

## 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.
- `path` - the path to the form element matching the `name`.
- `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
---
Expand Down

0 comments on commit f97b728

Please sign in to comment.