Update API docs

packages/core/docs/functions/ArrayField.md

@@ -28,4 +28,4 @@ the array field props
 
 ## Source
 
-[lib/components/ArrayField.component.tsx:62](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/ArrayField.component.tsx#L62)
+[lib/components/ArrayField.component.tsx:63](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/ArrayField.component.tsx#L63)

packages/core/docs/functions/Field.md

@@ -30,4 +30,4 @@ the field props
 
 ## Source
 
-[lib/components/Field.component.tsx:78](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/Field.component.tsx#L78)
+[lib/components/Field.component.tsx:79](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/Field.component.tsx#L79)

packages/core/docs/functions/FormProvider.md

@@ -26,4 +26,4 @@ the provider component props
 
 ## Source
 
-[lib/Form.provider.tsx:139](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.provider.tsx#L139)
+[lib/Form.provider.tsx:148](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.provider.tsx#L148)

packages/core/docs/functions/arrayFieldOf.md

@@ -39,4 +39,4 @@ const ArrayField = arrayFieldOf<User>();
 
 ## Source
 
-[lib/components/ArrayField.component.tsx:100](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/ArrayField.component.tsx#L100)
+[lib/components/ArrayField.component.tsx:101](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/ArrayField.component.tsx#L101)

packages/core/docs/functions/fieldOf.md

@@ -51,4 +51,4 @@ const Field = fieldOf<User>();
 
 ## Source
 
-[lib/components/Field.component.tsx:137](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/Field.component.tsx#L137)
+[lib/components/Field.component.tsx:138](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/Field.component.tsx#L138)

packages/core/docs/functions/useForm.md

@@ -24,4 +24,4 @@ the entire value of the form context
 
 ## Source
 
-[lib/Form.context.ts:209](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L209)
+[lib/Form.context.ts:210](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L210)

packages/core/docs/functions/useFormSelector.md

@@ -30,4 +30,4 @@ the selected value
 
 ## Source
 
-[lib/Form.context.ts:221](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L221)
+[lib/Form.context.ts:222](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L222)

packages/core/docs/interfaces/ArrayFieldProps.md

@@ -39,7 +39,7 @@ render props same as the `useArrayField` hook result
 
 #### Source
 
-[lib/components/ArrayField.component.tsx:41](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/ArrayField.component.tsx#L41)
+[lib/components/ArrayField.component.tsx:42](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/ArrayField.component.tsx#L42)
 
 ***
 
@@ -54,7 +54,7 @@ state changes when required.
 
 #### Source
 
-[lib/components/ArrayField.component.tsx:48](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/ArrayField.component.tsx#L48)
+[lib/components/ArrayField.component.tsx:49](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/ArrayField.component.tsx#L49)
 
 ***
 
@@ -66,4 +66,4 @@ The path to the array field in `T`.
 
 #### Source
 
-[lib/components/ArrayField.component.tsx:52](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/ArrayField.component.tsx#L52)
+[lib/components/ArrayField.component.tsx:53](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/ArrayField.component.tsx#L53)

packages/core/docs/interfaces/FieldProps.md

@@ -44,7 +44,7 @@ the render props same as `useField` result
 
 #### Source
 
-[lib/components/Field.component.tsx:53](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/Field.component.tsx#L53)
+[lib/components/Field.component.tsx:54](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/Field.component.tsx#L54)
 
 ***
 
@@ -59,7 +59,7 @@ external state changes when required.
 
 #### Source
 
-[lib/components/Field.component.tsx:60](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/Field.component.tsx#L60)
+[lib/components/Field.component.tsx:61](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/Field.component.tsx#L61)
 
 ***
 
@@ -71,7 +71,7 @@ optional default value the field should take
 
 #### Source
 
-[lib/components/Field.component.tsx:64](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/Field.component.tsx#L64)
+[lib/components/Field.component.tsx:65](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/Field.component.tsx#L65)
 
 ***
 
@@ -83,4 +83,4 @@ the path of the field in `T`
 
 #### Source
 
-[lib/components/Field.component.tsx:68](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/Field.component.tsx#L68)
+[lib/components/Field.component.tsx:69](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/Field.component.tsx#L69)

packages/core/docs/interfaces/FieldRenderProps.md

@@ -73,7 +73,7 @@ a function to map the callback arguments to the next value
 
 #### Source
 
-[lib/components/Field.component.tsx:30](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/Field.component.tsx#L30)
+[lib/components/Field.component.tsx:31](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/Field.component.tsx#L31)
 
 ***
 

packages/core/docs/interfaces/FormCtxt.md

@@ -29,7 +29,7 @@ either a new touched `Map<Path<T>, boolean>` or its equivalent
 
 #### Source
 
-[lib/Form.context.ts:136](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L136)
+[lib/Form.context.ts:137](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L137)
 
 ***
 
@@ -45,7 +45,7 @@ either a new `T` object or its equivalent action callback
 
 #### Source
 
-[lib/Form.context.ts:142](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L142)
+[lib/Form.context.ts:143](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L143)
 
 ***
 
@@ -62,7 +62,7 @@ either a new violations `Map<Path<T>, string>` or its equivalent
 
 #### Source
 
-[lib/Form.context.ts:149](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L149)
+[lib/Form.context.ts:150](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L150)
 
 ***
 
@@ -78,7 +78,7 @@ Submits the form when called.
 
 #### Source
 
-[lib/Form.context.ts:153](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L153)
+[lib/Form.context.ts:154](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L154)
 
 ***
 
@@ -90,7 +90,7 @@ True if the form was submitted before, false otherwise.
 
 #### Source
 
-[lib/Form.context.ts:157](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L157)
+[lib/Form.context.ts:158](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L158)
 
 ***
 
@@ -102,7 +102,7 @@ A Map of the path and a touched state boolean.
 
 #### Source
 
-[lib/Form.context.ts:161](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L161)
+[lib/Form.context.ts:162](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L162)
 
 ***
 
@@ -116,7 +116,7 @@ Form context provider.
 
 #### Source
 
-[lib/Form.context.ts:167](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L167)
+[lib/Form.context.ts:168](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L168)
 
 ***
 
@@ -128,7 +128,7 @@ The state of the values `T` of the form.
 
 #### Source
 
-[lib/Form.context.ts:171](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L171)
+[lib/Form.context.ts:172](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L172)
 
 ***
 
@@ -140,4 +140,4 @@ A Map of the path and a violation message (if any).
 
 #### Source
 
-[lib/Form.context.ts:175](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L175)
+[lib/Form.context.ts:176](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L176)

packages/core/docs/interfaces/FormProviderProps.md

@@ -26,7 +26,7 @@ returns a React.js node.
 
 #### Source
 
-[lib/Form.provider.tsx:110](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.provider.tsx#L110)
+[lib/Form.provider.tsx:119](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.provider.tsx#L119)
 
 ***
 
@@ -48,7 +48,7 @@ the validated values `T` of the form
 
 #### Source
 
-[lib/Form.provider.tsx:116](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.provider.tsx#L116)
+[lib/Form.provider.tsx:125](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.provider.tsx#L125)
 
 ***
 
@@ -65,7 +65,7 @@ tells the form and the hooks how to handle the validation.
 
 #### Source
 
-[lib/Form.provider.tsx:125](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.provider.tsx#L125)
+[lib/Form.provider.tsx:134](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.provider.tsx#L134)
 
 ***
 
@@ -78,4 +78,4 @@ the field values as well.
 
 #### Source
 
-[lib/Form.provider.tsx:130](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.provider.tsx#L130)
+[lib/Form.provider.tsx:139](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.provider.tsx#L139)

packages/core/docs/interfaces/RenderProps.md

@@ -64,7 +64,7 @@ either a value or a callback to change it
 
 #### Source
 
-[lib/Form.provider.tsx:65](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.provider.tsx#L65)
+[lib/Form.provider.tsx:74](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.provider.tsx#L74)
 
 ***
 
@@ -103,7 +103,7 @@ the path to change the value
 
 #### Source
 
-[lib/Form.provider.tsx:87](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.provider.tsx#L87)
+[lib/Form.provider.tsx:96](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.provider.tsx#L96)
 
 ***
 
@@ -119,7 +119,7 @@ Helper function that triggers the form submit on demand.
 
 #### Source
 
-[lib/Form.provider.tsx:91](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.provider.tsx#L91)
+[lib/Form.provider.tsx:100](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.provider.tsx#L100)
 
 ***
 
@@ -132,4 +132,4 @@ because they might not be present or changed by the user yet.
 
 #### Source
 
-[lib/Form.provider.tsx:96](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.provider.tsx#L96)
+[lib/Form.provider.tsx:105](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.provider.tsx#L105)

packages/core/docs/type-aliases/ArrayFieldOf.md

@@ -31,4 +31,4 @@ struct type of the form values
 
 ## Source
 
-[lib/components/ArrayField.component.tsx:24](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/ArrayField.component.tsx#L24)
+[lib/components/ArrayField.component.tsx:25](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/ArrayField.component.tsx#L25)

packages/core/docs/type-aliases/ArrayValue.md

@@ -22,4 +22,4 @@ the path type of the array field
 
 ## Source
 
-[lib/components/ArrayField.component.tsx:13](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/ArrayField.component.tsx#L13)
+[lib/components/ArrayField.component.tsx:14](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/ArrayField.component.tsx#L14)

packages/core/docs/type-aliases/ChangeCallback.md

@@ -35,4 +35,4 @@ callback arguments types
 
 ## Source
 
-[lib/Form.provider.tsx:27](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.provider.tsx#L27)
+[lib/Form.provider.tsx:36](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.provider.tsx#L36)

packages/core/docs/type-aliases/DeepPartial.md

@@ -19,4 +19,4 @@ the object type to make partial recursively
 
 ## Source
 
-[lib/Form.context.ts:29](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L29)
+[lib/Form.context.ts:30](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L30)

packages/core/docs/type-aliases/FieldOf.md

@@ -32,4 +32,4 @@ struct type of the form values
 
 ## Source
 
-[lib/components/Field.component.tsx:13](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/Field.component.tsx#L13)
+[lib/components/Field.component.tsx:14](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/Field.component.tsx#L14)

packages/core/docs/type-aliases/Optional.md

@@ -18,4 +18,4 @@ the type to make optional
 
 ## Source
 
-[lib/Form.context.ts:14](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L14)
+[lib/Form.context.ts:15](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L15)

packages/core/docs/type-aliases/Path.md

@@ -23,4 +23,4 @@ the type the paths should match including `undefined`
 
 ## Source
 
-[lib/Form.context.ts:48](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L48)
+[lib/Form.context.ts:49](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L49)

packages/core/docs/type-aliases/SetValue.md

@@ -26,4 +26,4 @@ the type of the value to change
 
 ## Source
 
-[lib/Form.provider.tsx:38](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.provider.tsx#L38)
+[lib/Form.provider.tsx:47](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.provider.tsx#L47)

packages/core/docs/type-aliases/Struct.md

@@ -13,4 +13,4 @@ type.
 
 ## Source
 
-[lib/Form.context.ts:21](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L21)
+[lib/Form.context.ts:22](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L22)

packages/core/docs/type-aliases/ValueByPath.md

@@ -22,4 +22,4 @@ the [Path](Path.md) type to get the value type
 
 ## Source
 
-[lib/Form.context.ts:107](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L107)
+[lib/Form.context.ts:108](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L108)

packages/web/docs/functions/Select.md

@@ -31,4 +31,4 @@ the SelectProps plus the HTMLSelectElement attributes
 
 ## Source
 
-[packages/web/src/lib/fields/Select.component.tsx:81](https://github.com/JoseLion/lynxts/blob/main/packages/web/src/lib/fields/Select.component.tsx#L81)
+[packages/web/src/lib/fields/Select.component.tsx:90](https://github.com/JoseLion/lynxts/blob/main/packages/web/src/lib/fields/Select.component.tsx#L90)

packages/web/docs/functions/selectOf.md

@@ -45,4 +45,4 @@ const Select = selectOf<User>();
 
 ## Source
 
-[packages/web/src/lib/fields/Select.component.tsx:202](https://github.com/JoseLion/lynxts/blob/main/packages/web/src/lib/fields/Select.component.tsx#L202)
+[packages/web/src/lib/fields/Select.component.tsx:211](https://github.com/JoseLion/lynxts/blob/main/packages/web/src/lib/fields/Select.component.tsx#L211)

packages/web/docs/interfaces/SelectProps.md

@@ -1307,7 +1307,7 @@ false
 
 #### Source
 
-[packages/web/src/lib/fields/Select.component.tsx:19](https://github.com/JoseLion/lynxts/blob/main/packages/web/src/lib/fields/Select.component.tsx#L19)
+[packages/web/src/lib/fields/Select.component.tsx:28](https://github.com/JoseLion/lynxts/blob/main/packages/web/src/lib/fields/Select.component.tsx#L28)
 
 ***
 
@@ -1444,7 +1444,7 @@ element when this prop is omited, `undefined`, or an empty string.
 
 #### Source
 
-[packages/web/src/lib/fields/Select.component.tsx:24](https://github.com/JoseLion/lynxts/blob/main/packages/web/src/lib/fields/Select.component.tsx#L24)
+[packages/web/src/lib/fields/Select.component.tsx:33](https://github.com/JoseLion/lynxts/blob/main/packages/web/src/lib/fields/Select.component.tsx#L33)
 
 ***
 
@@ -1476,7 +1476,7 @@ false
 
 #### Source
 
-[packages/web/src/lib/fields/Select.component.tsx:30](https://github.com/JoseLion/lynxts/blob/main/packages/web/src/lib/fields/Select.component.tsx#L30)
+[packages/web/src/lib/fields/Select.component.tsx:39](https://github.com/JoseLion/lynxts/blob/main/packages/web/src/lib/fields/Select.component.tsx#L39)
 
 ***
 
@@ -1488,7 +1488,7 @@ The name of the field as a Path|Path\<T\>.
 
 #### Source
 
-[packages/web/src/lib/fields/Select.component.tsx:34](https://github.com/JoseLion/lynxts/blob/main/packages/web/src/lib/fields/Select.component.tsx#L34)
+[packages/web/src/lib/fields/Select.component.tsx:43](https://github.com/JoseLion/lynxts/blob/main/packages/web/src/lib/fields/Select.component.tsx#L43)
 
 ***
 
@@ -3758,7 +3758,7 @@ An array of values which will be used to create the `<option>` elements.
 
 #### Source
 
-[packages/web/src/lib/fields/Select.component.tsx:38](https://github.com/JoseLion/lynxts/blob/main/packages/web/src/lib/fields/Select.component.tsx#L38)
+[packages/web/src/lib/fields/Select.component.tsx:47](https://github.com/JoseLion/lynxts/blob/main/packages/web/src/lib/fields/Select.component.tsx#L47)
 
 ***
 
@@ -3832,7 +3832,7 @@ The text to render besides the label text when the field is requried.
 
 #### Source
 
-[packages/web/src/lib/fields/Select.component.tsx:44](https://github.com/JoseLion/lynxts/blob/main/packages/web/src/lib/fields/Select.component.tsx#L44)
+[packages/web/src/lib/fields/Select.component.tsx:53](https://github.com/JoseLion/lynxts/blob/main/packages/web/src/lib/fields/Select.component.tsx#L53)
 
 ***
 
@@ -4029,7 +4029,7 @@ each option to be mapped
 
 #### Source
 
-[packages/web/src/lib/fields/Select.component.tsx:54](https://github.com/JoseLion/lynxts/blob/main/packages/web/src/lib/fields/Select.component.tsx#L54)
+[packages/web/src/lib/fields/Select.component.tsx:63](https://github.com/JoseLion/lynxts/blob/main/packages/web/src/lib/fields/Select.component.tsx#L63)
 
 ***
 
@@ -4089,7 +4089,7 @@ The text to use whenever the field has no selected values.
 
 #### Source
 
-[packages/web/src/lib/fields/Select.component.tsx:60](https://github.com/JoseLion/lynxts/blob/main/packages/web/src/lib/fields/Select.component.tsx#L60)
+[packages/web/src/lib/fields/Select.component.tsx:69](https://github.com/JoseLion/lynxts/blob/main/packages/web/src/lib/fields/Select.component.tsx#L69)
 
 ***