@iwsio/forms - npm Package Compare versions

Comparing version 5.0.1 to 5.0.2

package.json

		{
		"name": "@iwsio/forms",
		"version": "5.0.1",
		"version": "5.0.2",
		"description": "Simple library with useful React forms components and browser validation.",
		@@ -19,2 +19,3 @@ "main": "dist/index.js",
		"build": "tsc --build tsconfig.build.json",
		"clean": "tsc --build tsconfig.build.json --clean",
		"lint": "eslint src"
		@@ -21,0 +22,0 @@ },

README.md

		@@ -9,7 +9,2 @@ # @iwsio/forms

		## Breaking Changes in 4.0
		I've been continuing to make improvements while I use it myself in projects. This time, the breaking change is the signature on `useFieldState(fields, defaults, onValidSubmit, errorMapping)`, which seems to be getting pretty long and ambiguious. The first two arguments are even the same type. So I've turned this into an object to more clearly define the options. This signature now looks like: `useFieldState(fields, options)` with options being nearly the same definition, just as an object: `{ defaults, errorMapping }`.

		I removed `onValidSubmit` from the `fieldState` altogether. This seemed oddly placed to me, and I started twisting myself trying dealing with chicken and egg problems: (like passing it into `useFieldState` while still using the output of this function within the `onValidSubmit` function). To clean this up, now `onValidSubmit` is solely a prop on the components: `FieldManager` and `ControlledFieldManager`.

		## Install
		@@ -29,3 +24,3 @@

		Complimenting the inputs, I've included a form component to simplify styling and validated submit handling. It includes some CSS sugar `needs-validation` and `was-validated` for pre and post first submission. (This is kind of a throwback to Bootstrap, but you can use it however you like). You also still have acess to the psuedo classes `:valid` or `:invalid` as usual with these input components.
		Complimenting the inputs, I've included a form component to simplify styling and validated submit handling. It includes some CSS sugar `needs-validation` and `was-validated` for pre and post first submission. (This is kind of a throwback to Bootstrap, but you can use it however you like). You also still have access to the pseudo classes `:valid` or `:invalid` as usual with these input components.

		@@ -32,0 +27,0 @@ `onValidSubmit` invokes when form submit happens with all valid inputs. It's the same as using a regular `<form/>` `onSubmit` but with a built-in `form.checkValidity()` call to ensure field inputs are valid. `className` provided here will style the underlying HTML form.

@iwsio/forms - npm Package Compare versions

Worsened metrics