@radicalbit/formbit 1.0.0 → 1.2.0

package/README.md

@@ -33,6 +33,7 @@ Formbit is a **lightweight React state form library** designed to simplify form
   - [LiveValidationFn](#livevalidationfn)
   - [Object](#object)
   - [Remove](#remove)
+  - [RemoveAll](#removeall)
   - [ResetForm](#resetform)
   - [SetError](#seterror)
   - [SetSchema](#setschema)
@@ -107,14 +108,20 @@ function Example() {
     yup: schema
   });
 
-  const handleChangeName = ({ target: { value } }) => write('name', value);
-  const handleChangeAge = ({ target: { value } }) => write('age', value);
-  const onSubmit = () => console.log('Form Submitted!');
-  const onError = () => console.error('Form is invalid');
-  const handleSubmit = () => submitForm(onSubmit, onError);
+  const handleChangeName = ({ target: { value } }) => { write('name', value); }
+  const handleChangeAge = ({ target: { value } }) => { write('age', value); }
+  const handleSubmit = () => {
+    submitForm(
+      (writer) => {
+        console.log("Your validated form is: ", writer.form)
+      }, 
+      (writer) => {
+        console.error("The validation errors are: ", writer.errors)
+      });
+    }
 
   return (
-    <>
+    <div>
       <label name="name">Name</label>
       <input
         name="name"
@@ -136,7 +143,7 @@ function Example() {
       <button disabled={isFormInvalid()} onClick={handleSubmit} type="button">
         Submit
       </button>
-    </>
+    </div>
   );
 }
 
@@ -179,7 +186,7 @@ It returns undefined if the json is valid.
 
 #### Defined in
 
-[index.ts:14](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L14)
+[index.ts:14](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L14)
 
 ___
 
@@ -205,7 +212,7 @@ Options object to change the behavior of the check method
 
 #### Defined in
 
-[index.ts:302](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L302)
+[index.ts:309](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L309)
 
 ___
 
@@ -225,7 +232,7 @@ Reset isDirty value to false
 
 #### Defined in
 
-[index.ts:20](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L20)
+[index.ts:20](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L20)
 
 ___
 
@@ -258,7 +265,7 @@ Invoked in case of errors raised by validation
 
 #### Defined in
 
-[index.ts:25](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L25)
+[index.ts:25](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L25)
 
 ___
 
@@ -293,7 +300,7 @@ Invoked in case of errors raised by validation of check method
 
 #### Defined in
 
-[index.ts:31](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L31)
+[index.ts:31](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L31)
 
 ___
 
@@ -320,7 +327,7 @@ It doesn't trigger any validation
 
 #### Defined in
 
-[index.ts:39](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L39)
+[index.ts:39](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L39)
 
 ___
 
@@ -348,7 +355,7 @@ and age is a non valid field, errors object will look like this
 
 #### Defined in
 
-[index.ts:60](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L60)
+[index.ts:60](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L60)
 
 ___
 
@@ -360,7 +367,7 @@ Object containing the updated form
 
 #### Defined in
 
-[index.ts:65](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L65)
+[index.ts:65](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L65)
 
 ___
 
@@ -391,6 +398,7 @@ It contains all the data and methods needed to handle the form.
 | `isFormValid` | [`IsFormValid`](#isformvalid) | Returns true id the form is valid It doesn't perform any validation, it checks if any errors are present |
 | `liveValidation` | [`LiveValidationFn`](#livevalidationfn) | Returns true if live validation is active for the given path |
 | `remove` | [`Remove`](#remove)\<`Values`\> | This method updates the form state deleting value, setting isDirty to true. After writing, it validates all the paths contained into pathsToValidate (if any) and all the fields that have the live validation active. |
+| `removeAll` | [`RemoveAll`](#removeall)\<`Values`\> | This method updates the form state deleting multiple values, setting isDirty to true. |
 | `resetForm` | [`ResetForm`](#resetform) | Reset form to the initial state. Errors and liveValidation are set back to empty objects. isDirty is set back to false |
 | `setError` | [`SetError`](#seterror) | Set a message(value) to the given error path. |
 | `setSchema` | [`SetSchema`](#setschema)\<`Values`\> | Override the current schema with the given one. |
@@ -403,7 +411,7 @@ It contains all the data and methods needed to handle the form.
 
 #### Defined in
 
-[index.ts:341](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L341)
+[index.ts:348](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L348)
 
 ___
 
@@ -419,7 +427,7 @@ ___
 
 #### Defined in
 
-[index.ts:67](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L67)
+[index.ts:67](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L67)
 
 ___
 
@@ -431,7 +439,7 @@ InitialValues used to setup formbit, used also to reset the form to the original
 
 #### Defined in
 
-[index.ts:77](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L77)
+[index.ts:77](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L77)
 
 ___
 
@@ -463,7 +471,7 @@ Initialize the form with new initial values
 
 #### Defined in
 
-[index.ts:71](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L71)
+[index.ts:71](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L71)
 
 ___
 
@@ -475,7 +483,7 @@ Returns true if the form is Dirty (user already interacted with the form), false
 
 #### Defined in
 
-[index.ts:83](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L83)
+[index.ts:83](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L83)
 
 ___
 
@@ -496,7 +504,7 @@ It doesn't perform any validation, it checks if any errors are present
 
 #### Defined in
 
-[index.ts:89](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L89)
+[index.ts:89](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L89)
 
 ___
 
@@ -517,7 +525,7 @@ It doesn't perform any validation, it checks if any errors are present
 
 #### Defined in
 
-[index.ts:95](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L95)
+[index.ts:95](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L95)
 
 ___
 
@@ -550,7 +558,7 @@ and age is a field that is being live-validated, liveValidation object will look
 
 #### Defined in
 
-[index.ts:121](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L121)
+[index.ts:121](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L121)
 
 ___
 
@@ -576,7 +584,7 @@ Returns true if live validation is active for the given path
 
 #### Defined in
 
-[index.ts:127](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L127)
+[index.ts:127](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L127)
 
 ___
 
@@ -588,7 +596,7 @@ Generic object with string as keys
 
 #### Defined in
 
-[index.ts:133](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L133)
+[index.ts:133](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L133)
 
 ___
 
@@ -624,7 +632,40 @@ and all the fields that have the live validation active.
 
 #### Defined in
 
-[index.ts:152](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L152)
+[index.ts:152](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L152)
+
+___
+
+### RemoveAll
+
+Ƭ **RemoveAll**\<`Values`\>: (`arr`: `string`[], `options?`: [`WriteFnOptions`](#writefnoptions)\<`Values`\>) => `void`
+
+This method updates the form state deleting multiple values, setting isDirty to true.
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `Values` | extends [`InitialValues`](#initialvalues) |
+
+#### Type declaration
+
+▸ (`arr`, `options?`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `arr` | `string`[] |
+| `options?` | [`WriteFnOptions`](#writefnoptions)\<`Values`\> |
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[index.ts:278](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L278)
 
 ___
 
@@ -646,7 +687,7 @@ isDirty is set back to false
 
 #### Defined in
 
-[index.ts:160](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L160)
+[index.ts:160](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L160)
 
 ___
 
@@ -673,7 +714,7 @@ Set a message(value) to the given error path.
 
 #### Defined in
 
-[index.ts:175](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L175)
+[index.ts:175](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L175)
 
 ___
 
@@ -705,7 +746,7 @@ Override the current schema with the given one.
 
 #### Defined in
 
-[index.ts:181](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L181)
+[index.ts:181](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L181)
 
 ___
 
@@ -740,7 +781,7 @@ otherwise it executes the errorCallback
 
 #### Defined in
 
-[index.ts:188](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L188)
+[index.ts:188](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L188)
 
 ___
 
@@ -773,7 +814,7 @@ Success callback invoked by some formbit methods when the operation is successfu
 
 #### Defined in
 
-[index.ts:197](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L197)
+[index.ts:197](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L197)
 
 ___
 
@@ -807,7 +848,7 @@ Success callback invoked by the check method when the operation is successful.
 
 #### Defined in
 
-[index.ts:203](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L203)
+[index.ts:203](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L203)
 
 ___
 
@@ -842,7 +883,7 @@ Is the right place to send your data to the backend.
 
 #### Defined in
 
-[index.ts:211](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L211)
+[index.ts:211](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L211)
 
 ___
 
@@ -876,7 +917,7 @@ live validation active.
 
 #### Defined in
 
-[index.ts:222](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L222)
+[index.ts:222](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L222)
 
 ___
 
@@ -910,7 +951,7 @@ live validation active.
 
 #### Defined in
 
-[index.ts:229](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L229)
+[index.ts:229](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L229)
 
 ___
 
@@ -936,7 +977,7 @@ Options object to change the behavior of the validate methods
 
 #### Defined in
 
-[index.ts:312](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L312)
+[index.ts:319](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L319)
 
 ___
 
@@ -970,7 +1011,7 @@ This method validates the entire form and set the corresponding errors if any.
 
 #### Defined in
 
-[index.ts:235](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L235)
+[index.ts:235](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L235)
 
 ___
 
@@ -985,7 +1026,7 @@ Link to the Yup documentation [https://github.com/jquense/yup](https://github.co
 
 #### Defined in
 
-[index.ts:249](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L249)
+[index.ts:249](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L249)
 
 ___
 
@@ -1000,7 +1041,7 @@ Link to the Yup documentation [https://github.com/jquense/yup](https://github.co
 
 #### Defined in
 
-[index.ts:325](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L325)
+[index.ts:332](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L332)
 
 ___
 
@@ -1010,7 +1051,7 @@ ___
 
 #### Defined in
 
-[index.ts:240](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L240)
+[index.ts:240](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L240)
 
 ___
 
@@ -1031,7 +1072,7 @@ Link to the Yup documentation [https://github.com/jquense/yup](https://github.co
 
 #### Defined in
 
-[index.ts:169](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L169)
+[index.ts:169](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L169)
 
 ___
 
@@ -1068,7 +1109,7 @@ and all the fields that have the live validation active.
 
 #### Defined in
 
-[index.ts:258](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L258)
+[index.ts:258](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L258)
 
 ___
 
@@ -1107,7 +1148,7 @@ the fields that have the live validation active.
 
 #### Defined in
 
-[index.ts:271](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L271)
+[index.ts:271](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L271)
 
 ___
 
@@ -1125,7 +1166,7 @@ Tuple of [key, value] pair.
 
 #### Defined in
 
-[index.ts:278](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L278)
+[index.ts:285](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L285)
 
 ___
 
@@ -1143,7 +1184,7 @@ Options object to change the behavior of the write methods
 
 #### Defined in
 
-[index.ts:331](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L331)
+[index.ts:338](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L338)
 
 ___
 
@@ -1171,7 +1212,7 @@ Internal form state storing all the data of the form (except the validation sche
 
 #### Defined in
 
-[index.ts:290](https://github.com/radicalbit/formbit/blob/b189a1d/src/types/index.ts#L290)
+[index.ts:297](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L297)
 
 <!-- END_TYPES_DOC -->
 

package/dist/__tests__/miscellaneous.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/remove-all.test.d.ts

@@ -0,0 +1 @@
+export {};