From f97b7289686a16f45d9f992d7090c2e001821895 Mon Sep 17 00:00:00 2001 From: Romain Hamel Date: Mon, 6 May 2024 10:39:05 +0200 Subject: [PATCH] docs(Form): clarify when the `@error` event is triggered (#1747) --- docs/content/2.components/form.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/content/2.components/form.md b/docs/content/2.components/form.md index 72fba468..823bbba0 100644 --- a/docs/content/2.components/form.md +++ b/docs/content/2.components/form.md @@ -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 @@ -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 ---