Skip to content

Commit 3f7ea04

Browse files
committed
update readme and home page
1 parent 3c13a3a commit 3f7ea04

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -110,13 +110,13 @@ export default function App() {
110110

111111
## API
112112

113-
| Prop | Type | Required | Default | Description |
114-
| :-------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------: | :-----: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
115-
| `name` | string || | associated field name. |
116-
| `errors` | object | | | errors object from React Hook Form. It's optional if you are using `FormProvider`. |
117-
| `message` | string \| React.ReactElement | | | inline error message. |
118-
| `as` | string \|<br>React.ReactElement \| <br>React.ComponentType | | | Wrapper component or HTML tag. eg: `as="p"`, `as={<p />}` or `as={CustomComponent}` |
119-
| `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. |
113+
| Prop | Type | Required | Description |
114+
| :-------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
115+
| `name` | string || associated field name. |
116+
| `errors` | object | | errors object from React Hook Form. It's optional if you are using `FormProvider`. |
117+
| `message` | string \| React.ReactElement | | inline error message. |
118+
| `as` | string \|<br>React.ReactElement \| <br>React.ComponentType | | Wrapper component or HTML tag. eg: `as="p"`, `as={<p />}` or `as={CustomComponent}` |
119+
| `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. |
120120

121121
## Backers
122122

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
"bugs": {
4949
"url": "https://github.com/react-hook-form/error-message/issues"
5050
},
51-
"homepage": "https://github.com/react-hook-form/error-message#readme",
51+
"homepage": "https://react-hook-form.com/",
5252
"devDependencies": {
5353
"@rollup/plugin-commonjs": "^13.0.0",
5454
"@rollup/plugin-json": "^4.1.0",

0 commit comments

Comments
 (0)