File tree Expand file tree Collapse file tree 1 file changed +5
-5
lines changed
Expand file tree Collapse file tree 1 file changed +5
-5
lines changed Original file line number Diff line number Diff line change 77<p align =" center " >
88 <img src =" ./screenshot.gif " alt =" screenshot " />
99</p >
10-
10+
1111## Install
1212
1313#### npm
@@ -53,8 +53,8 @@ const MyComponent = () => {
5353| ` delaySpeed ` | number | Optional | Delay time between the words in Milliseconds | ` 1500 ` |
5454| ` loop ` | number \| boolean | Optional | Control how many times to run. ` 0 \| false ` to run infinitely | ` 1 ` |
5555| ` cursor ` | boolean | Optional | Show / Hide a cursor | ` false ` |
56- | ` cursorStyle ` | string | Optional | Change the cursor style available if ` cursor ` is ` enabled ` | ` \| ` |
57- | ` cursorBlinking ` | string | Optional | Enable cursor blinking animation | ` \| ` |
56+ | ` cursorStyle ` | ReactNode | Optional | Change the cursor style available if ` cursor ` is ` enabled ` | ` \| ` |
57+ | ` cursorBlinking ` | boolean | Optional | Enable cursor blinking animation | ` \| ` |
5858| ` onLoopDone ` | function | Optional | Callback function that is triggered when loops are completed. available if ` loop ` is ` > 0 ` | ` - ` |
5959| ` onType ` | function | Optional | Callback function that is triggered while typing with typed words ` count ` passed | ` - ` |
6060| ` onDelay ` | function | Optional | Callback function that is triggered on typing delay | ` - ` |
@@ -112,7 +112,7 @@ const MyComponent = () => {
112112 /**
113113 * @returns
114114 * text: [string] typed text
115- * count: [number] typed word count
115+ * helper: {} helper flags
116116 */
117117 const [text , helper ] = useTypewriter ({
118118 /* Config */
@@ -190,7 +190,7 @@ const MyComponent = () => {
190190 return (
191191 < div className= ' App' >
192192 < span> {text}< / span>
193- < Cursor / >
193+ < Cursor cursorColor = ' red ' / >
194194 < / div>
195195 )
196196}
You can’t perform that action at this time.
0 commit comments