Skip to content
This repository was archived by the owner on Jan 14, 2021. It is now read-only.

Commit ed40c8a

Browse files
committed
update readme
1 parent 2b54d3f commit ed40c8a

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
Inspiration and credit goes to <a href="https://github.com/JedWatson">Jed Watson</a> @github <a href="https://github.com/JedWatson/react-select/issues/3855">issue #3855</a>.
1818

1919
## ✨ Features
20+
2021
- isolate re-rendering at your component level
2122
- easily integrate with React Hook Form
2223
- tiny component
@@ -73,17 +74,17 @@ function App() {
7374

7475
## πŸ“– API
7576

76-
| Prop | Type | Required | Description |
77-
| :---------- | :-------- | :------: | :-------------------------------------------------------------------------------- |
78-
| `component` | Component | βœ“ | Component reference eg: `Select` from `react-select` |
79-
| `setValue` | Function | βœ“ | React Hook Form setValue function |
80-
| `register` | Function | βœ“ | React Hook Form register function |
81-
| `name` | string | βœ“ | Unique name for React Hook Form to register the input |
82-
| `trigger` | boolean | | Should trigger validation |
83-
| `rules` | Object | | Validation rules according to register at React Hook Form |
84-
| `type` | string | | Currently support `checkbox` or `input` input type includes: `radio` and `select` |
85-
| `value` | string | | value can be applied for checkbox |
86-
| `...rest` | Object | | any props assigned will be pass through to your Input component |
77+
| Prop | Type | Required | Description |
78+
| :---------- | :-------- | :------: | :--------------------------------------------------------------------------------------------------------------- |
79+
| `component` | Component | βœ“ | Component reference eg: `Select` from `react-select` |
80+
| `setValue` | Function | βœ“ | React Hook Form <a href="https://react-hook-form.com/api#setValue">setValue</a> function |
81+
| `register` | Function | βœ“ | React Hook Form <a href="https://react-hook-form.com/api#register">register</a> function |
82+
| `name` | string | βœ“ | Unique name for React Hook Form to register the input |
83+
| `trigger` | boolean | | Should trigger validation |
84+
| `rules` | Object | | Validation rules according to <a href="https://react-hook-form.com/api#register">register</a> at React Hook Form |
85+
| `type` | string | | Currently support `checkbox` or `input` input type includes: `radio` and `select` |
86+
| `value` | string | | value can be applied for `checkbox` |
87+
| `...rest` | Object | | any props assigned will be pass through to your Input component |
8788

8889
## Contributors
8990

0 commit comments

Comments
Β (0)