Skip to content

Commit 7ae187d

Browse files
committed
readme updated, example mistakes fixed
1 parent 19b35d5 commit 7ae187d

File tree

3 files changed

+6
-5
lines changed

3 files changed

+6
-5
lines changed

README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# react-type-animation
22

3-
A customizable React typing animation component.
3+
[![npm version](https://badge.fury.io/js/react-type-animation.svg)][npm_url]
4+
[![downloads](https://img.shields.io/npm/dt/react-type-animation.svg)][npm_url]
5+
[![license](https://img.shields.io/npm/l/react-type-animation.svg)][npm_url]
46

5-
<img style="float:left;margin-left:16px" src="https://raster.shields.io/npm/v/react-type-animation.png?logo=npm"/>
6-
<img style="margin-left:7px" src="https://raster.shields.io/npm/dt/react-type-animation.png">
7+
A customizable React typing animation component.
78

89
## Installation
910

example/components/examples/index.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ export function SplitterByWordExample() {
7676
speed={{ type: 'keyStrokeDelayInMs', value: 30 }}
7777
omitDeletionAnimation={true}
7878
style={{ fontSize: '1em', display: 'block', minHeight: '200px' }}
79-
splitter={(str) => str.split(/(?= )/)} // 'abc' => ['a', ' b', ' c']
79+
splitter={(str) => str.split(/(?= )/)} // 'Lorem ipsum dolor' -> ['Lorem', ' ipsum', ' dolor']
8080
repeat={Infinity}
8181
/>
8282
</div>

example/pages/examples.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -408,7 +408,7 @@ To create a word-level typing animation similar to ChatGPT or other AI chatbots,
408408
<SplitterByWordExample/>
409409
```tsx {2,8}
410410
<TypeAnimation
411-
splitter={(str) => str.split(/(?= )/)} // 'abc' => ['a', ' b', ' c']
411+
splitter={(str) => str.split(/(?= )/)} // 'Lorem ipsum dolor' -> ['Lorem', ' ipsum', ' dolor']
412412
sequence={[
413413
'Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.',
414414
3000,

0 commit comments

Comments
 (0)