Skip to content
This repository was archived by the owner on Jun 15, 2022. It is now read-only.

Commit 54333d0

Browse files
committed
add api section in README.md
1 parent c36bbf6 commit 54333d0

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,27 @@ export default function App() {
9999
| `['foo', 'bar']` | `foo.bar` |
100100
| `['foo', 'bar', 0]` | `foo.bar[0]` |
101101

102+
## API
103+
104+
- useTypedController
105+
106+
| Name | Type | Required |
107+
| :-------- | :------- | :------- |
108+
| `control` | `Object` | |
109+
110+
---
111+
112+
- TypedController
113+
114+
| Name | Type | Required |
115+
| :------------- | :------------------------------------------ | :------- |
116+
| `name` | `string | [string, ...(string | number)[]]` ||
117+
| `as` | `'input' | 'select' | 'textarea'` | |
118+
| `render` | `Function` | |
119+
| `defaultValue` | `DeepPathValue` | |
120+
| `rules` | `Object` | |
121+
| `onFocus` | `() => void` | |
122+
102123
## Backers
103124

104125
Thanks goes to all our backers! [[Become a backer](https://opencollective.com/react-hook-form#backer)].

0 commit comments

Comments
 (0)