A simple to use React validator hook.
You need to apply multiple validators on form inputs - and not only - and declaratively render a UI using these rules, by applying CSS classes, displaying custom error messages, etc.
react-validatus-hook is a simple and light-weight React hook that lets you apply as many validators you need and render your desired UI (by taking advantage of React's hook API pattern). The hook is using the excellent validator.js that does the heavy lifting of the validations.
npm install --save react-validatus-hook
The useValidatus hook requires 2 arguments in order to work. The first one is the value that you want to validate, which MUST be of type string. The second one is the validators you want to apply for the previous value. The validators MUST be an array of strings and / or objects. You can view all the validators (names, options, etc.) at the official documentation of validator.js. Each validator will validate the value prop. With this in mind you can use any of the available validators simply by passing their names as strings (ex. "isEmail"). If you need to pass options to a validator you need to pass an object with the name of the validator as key and its options as the value (ex. { isLength: { min:3, max: 10} }).
Finally, when you destruct the hook, you get back an object with 2 keys. The first one is the isValid key that it's type of boolean and is true only if ALL validators are passing (in any other case is false). The second key validations, is an object with key names the names of the applied validators and values a boolean for their status (ex. validations: { isEmail: true, isLength: false}). If an individual validator is passing, the boolean value will be true otherwise will be false.
Example:
At the below example the value email will be validated with the following validators: isRequired, isEmail, contains and isLength (read more information about the available validators). As you can see the last 2 validators have options. The isValid key will be true ONLY if all validators return true. You can also get individually every validation result from the validations object.
For more examples please check the examples directory.
function EmailInput({ email, updateEmail }) {
const { isValid, validations } = useValidatus(email, ["isRequired", "isEmail", { contains: "@gmail" }, { isLength: { min:3, max: 15 } }]);
return (
<div className="form-group">
<label htmlFor="email">Email address</label>
<input
id="email"
type="text"
name="email"
value={email}
onChange={updateEmail}
className={`form-control ${!isValid && "is-invalid"}`}
placeholder="Enter email"
/>
{ !validations.isRequired && <div className="invalid-feedback">Field is required</div> }
{ !validations.isEmail && <div className="invalid-feedback">Field must be a valid email</div> }
{ !validations.contains && <div className="invalid-feedback">Field must contain "@gmail"</div> }
{ !validations.isLength && <div className="invalid-feedback">Length must be between 3 and 15</div> }
</div>
);
}Sure, have a look into the examples directory.
Here you can view all the available validators and their the otpions / documentation. Keep in mind that you can use only the validators, not the sanitizers.
Feel free to contribute (see below how you can build, lint and test the package).
You need to have node.js installed (any recent node / npm version will do). When you are ready, you can install all dependencies and run the webpack dev server by typing the below commands:
npm install
npm start
open http://localhost:3000
Feel free to change the port from package.json.
Lint all js files:
npm run lint
Auto-fix linting issues:
npm run lint:fix
Run all test by typing:
npm test
MIT
- isMobilePhone cannot accept the third argument (currently the Component supports only validators with maximum arity of 2).