Skip to content

Fix/readme code formate #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Jun 16, 2020
Merged

Fix/readme code formate #8

Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
6bf59d5
try to fix code format
bluebill1049 Jun 16, 2020
2bc814c
update readme
bluebill1049 Jun 16, 2020
a813a4a
update readme
bluebill1049 Jun 16, 2020
d910681
update readme
bluebill1049 Jun 16, 2020
8c25617
update readme
bluebill1049 Jun 16, 2020
228c5d6
reduce font
bluebill1049 Jun 16, 2020
6117603
reduce font
bluebill1049 Jun 16, 2020
8b59a7f
give a break line
bluebill1049 Jun 16, 2020
79bfc7e
give a dot point
bluebill1049 Jun 16, 2020
fb13d84
update readme
bluebill1049 Jun 16, 2020
257ae68
update readme
bluebill1049 Jun 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ $ npm install @hookform/error-message

## Quickstart

### Single Error Message
- Single Error Message

```jsx
import React from 'react';
Expand Down Expand Up @@ -62,7 +62,9 @@ export default function App() {
}
```

### Multiple Error Messages
---

- Multiple Error Messages

```jsx
import React from 'react';
Expand Down Expand Up @@ -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 \|<br>React.ReactElement \| <br>React.ComponentType | | Wrapper component or HTML tag. eg: `as="p"`, `as={<p />}` or `as={CustomComponent}` |
| `render` | (payload: {<br>&nbsp;&nbsp;message: string \| React.ReactElement;<br>&nbsp;&nbsp;messages?: Record<<br>&nbsp;&nbsp;&nbsp;&nbsp;string,<br>&nbsp;&nbsp;&nbsp;&nbsp;(string \| React.ReactElement \| boolean \| undefined)[]<br>&nbsp;&nbsp;>;<br>}) => React.ReactNode | | This is a [render prop](https://reactjs.org/docs/render-props.html) for rendering error message or messages. <br>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={<p />}` or `as={CustomComponent}` |
| `render` | `Function` | | This is a [render prop](https://reactjs.org/docs/render-props.html) for rendering error message or messages. <br><b>Note:</b> you need to set `criteriaMode` to `all` for using messages. |

## Backers

Expand Down