Skip to content

Commit c7ed8a7

Browse files
committed
docs: update README
1 parent 707ad63 commit c7ed8a7

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import Typist from 'react-typist-component';
1717

1818
const MyComponent = () => {
1919
return (
20-
<Typist typingDelay={100} cursor={<span className="cursor">|</span>}>
20+
<Typist typingDelay={100} cursor={<span className='cursor'>|</span>}>
2121
This is a typo
2222
<br />
2323
<Typist.Backspace count={5} />
@@ -123,7 +123,7 @@ This function will be called when the typing animation finishes. It will be call
123123

124124
**Default**: `(str: string) => str.split('')`
125125

126-
`Typist` will use this to get tokens from strings. It may be useful when you want to split your string in different way. For example, you can use [grapheme-splitter](https://github.com/orling/grapheme-splitter) to split string if your string contains emoji.
126+
`Typist` will use this function to get tokens from strings. It may be useful when you want to split your string in different way. For example, you can use [grapheme-splitter](https://github.com/orling/grapheme-splitter) to split string if your string contains emoji.
127127

128128
```tsx
129129
import GraphemeSplitter from 'grapheme-splitter';
@@ -150,7 +150,7 @@ Will be inserted after the last typed token.
150150

151151
**Default**: `false`
152152

153-
If this value is `true`, the result will be displayed immediately without typing animation. It can be useful if you don't want the typing effect anymore.
153+
If this value is `true`, the result will be displayed immediately without typing animation. It can be useful when you want to display the final result if a user has visited the typing animation.
154154

155155
#### `restartKey`
156156

@@ -190,4 +190,4 @@ type Props = {
190190

191191
#### `children`
192192

193-
Children inside this component will be pasted without typewriter effect.
193+
Children inside this component will be pasted without typewriter effect. Do not wrap another `Paste` inside this component, otherwise `Typist` will produce weird behavior.

0 commit comments

Comments
 (0)