README
react-class-validator
Easy-to-use React hook for validating forms with the class-validator library.
Installation
npm install --save react-class-validator
const validatorOptions: ValidatorContextOptions = {
onErrorMessage: (error): string => {
// custom error message handling (localization, etc)
},
resultType: 'boolean' // default, can also be set to 'map'
}
render((
<ValidatorProvider options={validatorOptions}>
<MyComponent />
</ValidatorProvider>
), document.getElementById('root'))
Default onErrorMessage behavior
The default behavior is to flatten all error constraints for each attribute.
const _getDefaultContextOptions = (): ValidatorContextOptions => ({
onErrorMessage: (error) => Object.keys(error.constraints).map((key) => error.constraints[key])
});
Usage
import { IsNotEmpty } from "class-validator";
class LoginValidation {
@IsNotEmpty({
message: 'username cannot be empty'
})
public username: string;
@IsNotEmpty({
message: 'password cannot be empty'
})
public password: string;
}
const MyComponent = () => {
const [username, setUsername] = useState('');
const [password, setPassword] = useState('');
const [validate, errors] = useValidation(LoginValidation);
return (
<form onSubmit={async (evt) => {
evt.preventDefault();
// `validate` will return true if the submission is valid
if (await validate({username, password})) {
// ... handle valid submission
}
}}>
{/* use a filter so that the onBlur function will only validate username */}
<input value={username} onChange={({target: {value}}) => setUsername(value)}
onBlur={() => validate({username}, ['username'])}/>
{/* show error */}
{errors.username && (
<div className="error">
{errors.username.map((message) => <strong>message</strong>)}
</div>
)}
</form>
);
};
Usage With Formik
react-class-validator
easily integrates with Formik. You can simply use the validate
function returned from useValidation
, so long as the Formik fields are named the same as the keys in your validation
class. Individual fields will have to be validated with onBlur
functionality.
Formik error messages
To display error messages without custom handling, messages will need to be outputted as a map upon validation.
Do this by overriding the default resultType
(you can also do this at the component-level).
const options: ValidatorContextOptions = {
resultType: 'map'
};
Then you can simply integrate with the default Formik flow.
export const Login: FunctionComponent = () => {
const [validate] = useValidation(LoginValidation);
return (
<Formik initialValues={{username: '', password: ''}}
validateOnBlur
validateOnChange
validate={validate}>
{({values, touched, errors, handleChange, handleBlur}) => (
<Form>
<label htmlFor="username">Username</label>
<Field id="username" name="username" placeholder="Username" />
{errors.username && touched.username ? (
<div>{errors.username}</div>
) : null}
{/* other fields */}
<button type="submit">
Submit
</button>
</Form>
)}
</Formik>
);
};
Contributors
Library built and maintained by Robin Schultz
If you would like to contribute (aka buy me a beer), you can send funds via PayPal at the link below.