Performant, flexible and extensible forms with easy to use validation.

Goal

A simple component to render associated input's error message.

Install

$ npm install @hookform/error-message

Quickstart

• Single Error Message

importReactfrom'react';import{useForm}from'react-hook-form';import{ErrorMessage}from'@hookform/error-message';exportdefaultfunctionApp(){const{ register,formState: { errors }, handleSubmit }=useForm();constonSubmit=(data)=>console.log(data);return(<formonSubmit={handleSubmit(onSubmit)}><inputname="singleErrorInput"ref={register({required: 'This is required.'})}/><ErrorMessageerrors={errors}name="singleErrorInput"/><ErrorMessageerrors={errors}name="singleErrorInput"render={({ message })=><p>{message}</p>}/><inputname="name"ref={register({required: true})}/><ErrorMessageerrors={errors}name="name"message="This is required"/><inputtype="submit"/></form>);}

---

• Multiple Error Messages

importReactfrom'react';import{useForm}from'react-hook-form';import{ErrorMessage}from'@hookform/error-message';exportdefaultfunctionApp(){const{ register,formState: { errors }, handleSubmit }=useForm({criteriaMode: 'all',});constonSubmit=(data)=>console.log(data);return(<formonSubmit={handleSubmit(onSubmit)}><inputname="multipleErrorInput"ref={register({required: 'This is required.',pattern: {value: /d+/,message: 'This input is number only.',},maxLength: {value: 10,message: 'This input exceed maxLength.',},})}/><ErrorMessageerrors={errors}name="multipleErrorInput"render={({ messages })=>messages&&Object.entries(messages).map(([type,message])=>(<pkey={type}>{message}</p>))}/><inputtype="submit"/></form>);}

API

Prop	Type	Required	Description
name	string	✓	Associated field name.
errors	object		errors object from React Hook Form. It's optional if you are using FormProvider.
message	string | React.ReactElement		inline error message.
as	string | React.ReactElement | React.ComponentType		Wrapper component or HTML tag. eg: as="p", as={<p />} or as={CustomComponent}. This prop is incompatible with prop render and will take precedence over it.
render	Function		This is a render prop for rendering error message or messages. Note: you need to set criteriaMode to all for using messages.

Backers

Thank goes to all our backers! [Become a backer].

Contributors

Thanks goes to these wonderful people. [Become a contributor].