Merge pull request #31 from kevinkosterr/master

Update documentation

Author: kevinkosterr

README.md

@@ -8,7 +8,7 @@ A schema-based form generator component for Vue 3, based on the original
 [![NPM Version](https://img.shields.io/npm/v/%40kevinkosterr%2Fvue3-form-generator?logo=npm)](https://www.npmjs.com/package/@kevinkosterr/vue3-form-generator)
 [![GitHub License](https://img.shields.io/github/license/kevinkosterr/vue3-form-generator)](https://github.com/kevinkosterr/vue3-form-generator?tab=MIT-1-ov-file)
 
-You can find documentation on the [documentation page](https://kevinkosterr.github.io/vue3-form-generator-docs).
+You can find documentation on the [documentation page](https://kevinkosterr.github.io/vue3-form-generator).
 
 ## Building for development
 1. Install the dependencies

apps/docs/guide/composables/useFieldProps.md

@@ -22,8 +22,8 @@ const { field, model } = toRefs(props)
 Id of the field, computed based on the `idPrefix` set within the FormGenerator component and `name` property of the 
 field. 
 
-### `formGenerator` <Badge type="info" text="Component"/>
-FormGenerator component.
+### `formOptions` <Badge type="info" text="Object"/>
+An object of global options for the current form.
 
 ### `field` <Badge type="info" text="Object"/> <Badge type="danger" text="required"/>
 Field object as set in the schema.

apps/docs/guide/composables/useFieldValidate.md

@@ -30,9 +30,18 @@ Field schema object, as returned by the props
 
 ### `validate` <Badge type="info" text="Function"/>
 > Validates the field, existing fields typically use this in an `onBlur()`
+- Arguments: 
+  - `currentModelValue: any` - the current value of the field.
 - Returns: `Promise<string[]>` - an array of error messages, or empty array if no errors have been found.
 ```javascript
-validate().then((validationErrors) => {
+validate(currentModelValue.value).then((validationErrors) => {
   //... 
 }) 
 ```
+
+### `errors` <Badge type="info" text="string[]" />
+> An array of errors that have been found when validating the current value against all validators
+ 
+::: warning
+If you want your component to work properly with validation, you'll have to expose this value.
+:::

apps/docs/guide/customization/custom-components.md

@@ -85,6 +85,12 @@ const onFieldValueChanged = ({ target }) => {
 ### Advanced example
 For a more advanced example, you can take a look at the [`FieldSelect`](/guide/fields/FieldSelect) ([source](https://github.com/kevinkosterr/vue3-form-generator/blob/69cb6aeb8e8c82926ec3598e7d73be2d1146a3f2/src/fields/core/FieldSelect.vue)) component.
 
+## Compatibility with validation
+::: info
+If you want your component to be compatible with validation, you'll need to expose the `errors` value that is returned
+by [`useFieldValidate`](/guide/composables/useFieldValidate)
+:::
+
 ## Registering your component
 To use your component inside the form generator, your component must be globally available throughout your app. You do this
 by simply registering it in your `main.js` file. Names <strong>must</strong> start with `Field`.