Skip to content

Commit df036f8

Browse files
committed
docs(FormGenerator): update events.md
1 parent 30e4f71 commit df036f8

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed
Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,27 @@
11
These are events emitted by the `vue-form-generator` component.
22

3+
## `field-validated`
4+
Emitted when a field inside the form has been validated.
5+
6+
### Event arguments
7+
- `validations` - an object with the field's errors and the field schema
8+
- `fieldErrors` - an array of error messages that have been thrown during validations;
9+
- `field` - the field as defined in the schema
10+
11+
An example from the [`FieldObject`](/guide/fields/FieldObject) component:
12+
```vue [FieldObject.vue]
13+
<script setup>
14+
const onFieldValidated = (validation) => {
15+
const key = `${field.value.model}.${validation.field.model}`
16+
emits(
17+
'validated',
18+
validation.fieldErrors.length === 0,
19+
validation.fieldErrors,
20+
{ ...field.value, model: key }
21+
)
22+
}
23+
</script>
24+
```
25+
326
## `submit`
4-
Emitted when all fields have been validated and no errors occurred during said validations.
27+
Emitted when all fields have been validated and no errors occurred during said validations.

0 commit comments

Comments
 (0)