Skip to content

Commit e12ec8a

Browse files
update readme : add ready function section
1 parent 9c92bfa commit e12ec8a

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ React Dynamic Tabs with full API
2323

2424
- [Installation](#installation)
2525
- [Basic Example](#basic-example)
26+
- [ready function](#ready-function)
2627
- [Options](#options)
2728
- [tabs](#tabs)
2829
- [selectedTabID](#selectedTabID)
@@ -123,13 +124,17 @@ export default () => {
123124
};
124125
```
125126

126-
**NOTE :**
127+
## ready function
127128

128-
- ready function and instance Object will not be changed after re-rendering multiple times.
129+
- ready function is returned by useDynTabs hook.
130+
131+
- ready function accepts a function as a parameter and calls it with instance object after the first render, when the component is mounted.
129132

130133
- Tabs can't be manipulated safely before the first render, use ready() to make a function available after the component is mounted.
131134

132-
- ready function accepts a function as a parameter and calls it with instance object after the first render, when the component is mounted.
135+
- ready function can be called multiple times
136+
137+
- ready function and instance Object will not be changed after re-rendering multiple times.
133138

134139
- When ready function is called after the first render, it calls its function parameter with instance object immediately.
135140

0 commit comments

Comments
 (0)