@bolttech/form-engine 0.11.1 → 0.11.3

package/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [0.11.3](http://bitbucket.org/gofrank/bolttech-frontend/compare/form-engine-0.11.2...form-engine-0.11.3) (2024-02-21)
+
+
+### Bug Fixes
+
+* react hook adapter ([02ae862](http://bitbucket.org/gofrank/bolttech-frontend/commit/02ae86208394e939d741e5622013e78af773257c))
+
+## [0.11.2](http://bitbucket.org/gofrank/bolttech-frontend/compare/form-engine-0.11.1...form-engine-0.11.2) (2024-02-21)
+
+
+### Bug Fixes
+
+* **handler:** add defaultClearFields prop on clearFields handler ([b5865f6](http://bitbucket.org/gofrank/bolttech-frontend/commit/b5865f66e2cb61f5a811bfab0d67fb9101bb3046))
+* **handler:** updating readme ([99b2ac8](http://bitbucket.org/gofrank/bolttech-frontend/commit/99b2ac8902f0b8834dd96d84a2fb44641a2c86d0))
+
 ## [0.11.1](http://bitbucket.org/gofrank/bolttech-frontend/compare/form-engine-0.11.0...form-engine-0.11.1) (2024-02-19)
 
 

package/README.md

@@ -2,7 +2,7 @@
 
 Achieve form logic re-usage with forms expressed in json format.
 
-> stable version 0.11.1
+> stable version 0.11.3
 
 ---
 
@@ -995,6 +995,30 @@ Each prop will be changed using the respective field. For example, if I have `fi
 I can send it as `clearedProps: [{ label: 'value' }]` or `clearedProps: { label: 'value' }`. And only input props will be changed. 
 It's useful when we have some API calls whose response will be used as a prop value in the component.
 
+```json
+{
+  "clearFields": {
+    "ON_FIELD_CHANGE": [
+      {
+        "validations": {
+          "value": "Yes"
+        },
+        "field": "targetValue",
+        "clearedValue": false,
+        "defaultClearedValue": true,
+        "defaultClearedProps": {
+          "disabled": false,
+        }
+      }
+    ]
+  }
+}
+```
+
+If you want to set a value when the validation passes you can set `defaultClearedValue` prop on the event to set a value on the cleared field.
+Useful after an API call to set a default response value or a value stored earlier.
+You can also set a `defaultClearedProps` attribute to change the props of the component if the validation passes.
+
 For definition clearValues runs validations on the target field and not on the field it is declaring.
 Therefore, you can set `useCurrentFieldValidation` prop with true if you want validations to be performed on the current field.
 
@@ -1654,6 +1678,7 @@ You can use the following arguments to tho hook
 | id       | string           | The id of the form you want to connect to              |
 | ids      | array of string  | A range of ids of the each form you want to connect to |
 | onValid  | callback         | Called whenever form validation changes                |
+| onClick  | callback         | Called whenever field has clicked                      |
 | onData   | callback         | Called whenever data changes                           |
 | onSubmit | callback         | Called whenever form is submitted                      |
 
@@ -1711,10 +1736,11 @@ Similar to `useForm`
 You can use the following arguments to tho hook
 
 | Prop     | Type            | Description                                               |
-| -------- | --------------- | --------------------------------------------------------- |
+| -------- | --------------- |-----------------------------------------------------------|
 | ids      | array of string | The ids we want to listen to                              |
 | group    | string          | A string to identify the form group we want to connect to |
 | onValid  | callback        | Called whenever form validation changes                   |
+| onClick  | callback        | Called whenever field has clicked                         |
 | onData   | callback        | Called whenever data changes                              |
 | onSubmit | callback        | Called whenever form is submitted                         |
 
@@ -1778,12 +1804,12 @@ Allows you to add separate components from a standard form engine form schema. T
 
 You can use the following arguments declare a component as a form field
 
-| Prop     | Type                     | Description                                                       |
-|----------|--------------------------|-------------------------------------------------------------------|
-| Comp     | React Function Component | The component to be used as form field.                           |
-| onSubmit | TPropsMapping            | Link for the TPropsMapping likely props mapper from default form. |
+| Prop          | Type                     | Description                                                                 |
+|---------------|--------------------------|-----------------------------------------------------------------------------|
+| Comp          | React Function Component | The component to be used as form field.                                     |
+| propsMapping  | TComponentPropsMapping   | Link for the TComponentPropsMapping likely props mapper from default form.  |
 
-And it will provide you the following
+And this will give you the following properties in addition to the native ones of your component
 
 | Prop                 | Type                        | Description                                                                                                                                                              |
 |----------------------|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|