react-simple-formkit 2.1.5 → 2.1.7

package/README.md

@@ -194,20 +194,20 @@ State updates only when observed via `watch()`, `useWatch()`, `subscribe()`, or
 - `onChange` is just a handler callback that is called when field values change.
 - `onBlur` is just a handler callback that is called when field blurred.
 
-> **Rule\*:** onBlur works for uncontrolled fields by default. But for controlled fields, you need to use onBlur when rendering a field. For captured fields, you need to use `actions.triggerFieldBlur(fieldName)` to trigger onBlur event.
+> **Rule\*:** By default, onBlur works automatically for uncontrolled fields. However, for controlled fields, you must explicitly pass the onBlur prop when rendering the field. For captured fields, use actions.triggerFieldBlur(fieldName) to manually trigger the onBlur event.
 
 ### The Power of watch (Unified Observation)
 
 The `watch` function (and `useWatch`, `subscribe`) is the "brain" of your form. Instead of having multiple hooks for different states, you can observe anything in the form using a unified dot-notation syntax:
 
-| Target              | Syntax Example                                                                                                                                                                                                                                    | Description                                  |
-| :------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------- |
-| **All Values**      | `watch()`                                                                                                                                                                                                                                         | Observe every field value in the form.       |
-| **Specific Value**  | `watch("email")`                                                                                                                                                                                                                                  | Observe changes for a specific field.        |
-| **Form State**      | `watch("formState")` <br/> `watch("formState.isDirty")` <br/> `watch("formState.isError")` <br/> `watch("formState.dirtyFields")` <br/> `watch("formState.touchedFields")` <br/> `watch("formState.errorFields")`                                 | Track if the form has been modified.         |
-| **Field States**    | `watch("fieldStates")` <br/> `watch("fieldStates.email")` <br/> `watch("fieldStates.email.isDirty")` <br/> `watch("fieldStates.email.isTouched")` <br/> `watch("fieldStates.email.isError")` <br/> `watch("fieldStates.email.customState")` <br/> | Monitor if a field has been interacted with. |
-| **Errors**          | `watch("errors")` <br/> `watch("errors.email")` <br/>                                                                                                                                                                                             | Get real-time validation error messages.     |
-| **Multiple values** | `watch(["email", "errors.email", "fieldStates.email", "formState.isDirty"])` <br/>                                                                                                                                                                | Get real-time validation error messages.     |
+| Target              | Syntax Example                                                                                                                                                                                                                                    |
+| :------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| **All Values**      | `watch()`                                                                                                                                                                                                                                         |
+| **Specific Value**  | `watch("email")`                                                                                                                                                                                                                                  |
+| **Form State**      | `watch("formState")` <br/> `watch("formState.isDirty")` <br/> `watch("formState.isError")` <br/> `watch("formState.dirtyFields")` <br/> `watch("formState.touchedFields")` <br/> `watch("formState.errorFields")`                                 |
+| **Field States**    | `watch("fieldStates")` <br/> `watch("fieldStates.email")` <br/> `watch("fieldStates.email.isDirty")` <br/> `watch("fieldStates.email.isTouched")` <br/> `watch("fieldStates.email.isError")` <br/> `watch("fieldStates.email.customState")` <br/> |
+| **Errors**          | `watch("errors")` <br/> `watch("errors.email")` <br/>                                                                                                                                                                                             |
+| **Multiple values** | `watch(["email", "errors.email", "fieldStates.email", "formState.isDirty"])` <br/>                                                                                                                                                                |
 
 > **💡Why it matters\*:** This unified approach ensures you only need to learn one API to track the entire lifecycle of your form.
 
@@ -416,7 +416,7 @@ Generic props:
 - `defaultValue`
 - `render({name, value, onChange, onBlur, customState, setCustomState})`
 
-## useController({ name, defaultValue })
+## useController
 
 Generic props:
 
@@ -425,7 +425,7 @@ Generic props:
 
 Return: everything in render function above
 
-## useWatch({ name, compute })
+## useWatch
 
 [Example](#manage-values)
 
@@ -441,14 +441,14 @@ Return:
 - if name is array: object of values of the fields
 - if name is undefined: object of all input values
 
-## useFormContext()
+## useFormContext
 
 Return:
 
 - `watch`
 - `actions`
 
-## watch(name)
+## watch
 
 Arguments:
 
@@ -458,7 +458,7 @@ Return:
 
 - same with useWatch()
 
-## subscribe(name, callback)
+## subscribe
 
 Arguments:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-simple-formkit",
-  "version": "2.1.5",
+  "version": "2.1.7",
   "keywords": [
     "react formkit",
     "react ez formkit",