Skip to content
This repository was archived by the owner on Apr 9, 2025. It is now read-only.

Commit 5c1107b

Browse files
author
Daniel Requejo
committed
🗄 Align docu tables
1 parent 8badb18 commit 5c1107b

File tree

3 files changed

+23
-23
lines changed

3 files changed

+23
-23
lines changed

docs/api/use-form-handler/form-state.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ Provides you with the reactive state of the form, including validation, dirty an
66

77
| attribute | type | description |
88
|-----------|--------|--------------------------------------------|
9-
| dirty | Record<string, boolean> | Object containing all the inputs that have been modified |
10-
| errors | Record<string, string> | Object containing all the current field errors of the form |
11-
| touched | Record<string, boolean> | Object containing all the inputs the users has interacted with |
12-
| isDirty | boolean | True if there is any modified field on the form |
13-
| isTouched | boolean | True if there has been any interaction with a form field |
14-
| isValid | boolean | True if there are no form errors |
9+
| dirty | `Record<string, boolean>` | Object containing all the inputs that have been modified |
10+
| errors | `Record<string, string>` | Object containing all the current field errors of the form |
11+
| touched | `Record<string, boolean>` | Object containing all the inputs the users has interacted with |
12+
| isDirty | `boolean` | True if there is any modified field on the form |
13+
| isTouched | `boolean` | True if there has been any interaction with a form field |
14+
| isValid | `boolean` | True if there are no form errors |
1515

1616
## Rules
1717

docs/api/use-form-handler/index.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -41,18 +41,18 @@ The interceptor will be called passing an object as a parameter with the followi
4141

4242
| attribute | type | description |
4343
|-----------|--------|--------------------------------------------|
44-
| name | string | Name of the field that is about to be set |
45-
| value | any | Value of the field that is about to be set |
46-
| clearError | ClearError | [API - clearError](/api/use-form-handler/clear-error) |
47-
| clearField | ClearField | [API - clearField](/api/use-form-handler/clear-field) |
48-
| formState | FormState | [API - formState](/api/use-form-handler/form-state) |
49-
| modifiedValues | ModifiedValues | [API - modifiedValues](/api/use-form-handler/modified-values) |
50-
| resetField | ResetField | [API - resetField](/api/use-form-handler/reset-field) |
51-
| resetForm | ResetForm | [API - resetForm](/api/use-form-handler/reset-form) |
52-
| setError | SetError | [API - setError](/api/use-form-handler/set-error) |
53-
| setValue | SetValue | [API - setValue](/api/use-form-handler/set-value) |
54-
| triggerValidation | TriggerValidation | [API - triggerValidation](/api/use-form-handler/trigger-validation) |
55-
| values | Record<string,any> | [API - values](/api/use-form-handler/values) |
44+
| name | `string` | Name of the field that is about to be set |
45+
| value | `any` | Value of the field that is about to be set |
46+
| clearError | [ClearError](/api/use-form-handler/clear-error#type-declarations) | [API - clearError](/api/use-form-handler/clear-error) |
47+
| clearField | [ClearField](/api/use-form-handler/clear-field#type-declarations) | [API - clearField](/api/use-form-handler/clear-field) |
48+
| formState | [FormState](/api/use-form-handler/form-state#type-declarations) | [API - formState](/api/use-form-handler/form-state) |
49+
| modifiedValues | [ModifiedValues](/api/use-form-handler/modified-values#type-declarations) | [API - modifiedValues](/api/use-form-handler/modified-values) |
50+
| resetField | [ResetField](/api/use-form-handler/reset-field#type-declarations) | [API - resetField](/api/use-form-handler/reset-field) |
51+
| resetForm | [ResetForm](/api/use-form-handler/reset-form#type-declarations) | [API - resetForm](/api/use-form-handler/reset-form) |
52+
| setError | [SetError](/api/use-form-handler/set-error#type-declarations) | [API - setError](/api/use-form-handler/set-error) |
53+
| setValue | [SetValue](/api/use-form-handler/set-value#type-declarations) | [API - setValue](/api/use-form-handler/set-value) |
54+
| triggerValidation | [TriggerValidation](/api/use-form-handler/trigger-validation#type-declarations) | [API - triggerValidation](/api/use-form-handler/trigger-validation) |
55+
| values | `Record<string,any>` | [API - values](/api/use-form-handler/values) |
5656

5757
::: info
5858
As you can see, the interceptor is provided with everything the handler does provide but in a separate context.
@@ -134,10 +134,10 @@ This option allows you to configure the validation mode or strategy the handler
134134

135135
| name | type | description |
136136
|-----------|--------|--------------------------------------------|
137-
| onChange | string | Validation will trigger on the change event with each input, and lead to multiple re-renders. |
138-
| onBlur | string | Validation will trigger on the blur event. |
139-
| onSubmit | string | Validation will trigger on the submit event. |
140-
| always | string | Validation will trigger on change and blur events. |
137+
| onChange | `string` | Validation will trigger on the change event with each input, and lead to multiple re-renders. |
138+
| onBlur | `string` | Validation will trigger on the blur event. |
139+
| onSubmit | `string` | Validation will trigger on the submit event. |
140+
| always | `string` | Validation will trigger on change and blur events. |
141141

142142
::: warning
143143
Using the `always` validationMode will have a more significant impact on performance.

docs/api/use-form-handler/values.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Provides you with the reactive state of the form, including validation, dirty an
66

77
| attribute | type | description |
88
|-----------|--------|--------------------------------------------|
9-
| &lt;fieldName&gt; | any | Current value of the specified field |
9+
| &lt;fieldName&gt; | `any` | Current value of the specified field |
1010
## Rules
1111

1212
`values` is read-only, so no assignments are expected. It is entirely reactive, so you can react on changes of the whole element and/or it's main attributes.

0 commit comments

Comments
 (0)