diff --git a/README.md b/README.md index 3dd0682..ed0a65a 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ $ npm install @hookform/error-message ## Quickstart -### Single Error Message +- Single Error Message ```jsx import React from 'react'; @@ -62,7 +62,9 @@ export default function App() { } ``` -### Multiple Error Messages +--- + +- Multiple Error Messages ```jsx import React from 'react'; @@ -110,13 +112,13 @@ export default function App() { ## 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={

}` or `as={CustomComponent}` | -| `render` | (payload: {
  message: string \| React.ReactElement;
  messages?: Record<
    string,
    (string \| React.ReactElement \| boolean \| undefined)[]
  >;
}) => React.ReactNode | | This is a [render prop](https://reactjs.org/docs/render-props.html) for rendering error message or messages.
Note: you need to set `criteriaMode` to `all` for using messages. | +| 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={

}` or `as={CustomComponent}` | +| `render` | `Function` | | This is a [render prop](https://reactjs.org/docs/render-props.html) for rendering error message or messages.
Note: you need to set `criteriaMode` to `all` for using messages. | ## Backers