# react-typing-animator

> A React component that animates a given text array into a looping typing animation of each word.

Latest version **7.0.1** (published 2025-01-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-typing-animator
pnpm add react-typing-animator
yarn add react-typing-animator
bun add react-typing-animator
```

## Health

**Score 35/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 7.0.1 |
| Published | 2025-01-18 |
| First published | 2023-03-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 59 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Jerry Satpathy |
| Maintainers | j3rry |
| Keywords | react, typing, animation, component, react-component, typing-animation, typing-effect, animation, cursor, typescript, nextjs, styled-components, UI animation |

## Links

- npm: https://www.npmjs.com/package/react-typing-animator
- Repository: https://github.com/J3rry320/react-typing-animator
- Homepage: https://github.com/J3rry320/react-typing-animator#readme
- Issues: https://github.com/J3rry320/react-typing-animator/issues
- npm.io page: https://npm.io/package/react-typing-animator

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 7.0.1 (latest) — 2025-01-18
- 7.0.0 — 2025-01-18
- 6.1.0 — 2024-09-02
- 6.0.0 — 2024-09-02
- 5.6.2 — 2023-08-17
- 5.6.1 — 2023-08-17
- 5.6.0 — 2023-08-17
- 5.5.0 — 2023-03-31
- 5.3.0 — 2023-03-31
- 5.2.0 — 2023-03-31
- 5.1.0 — 2023-03-31
- 5.0.0 — 2023-03-31
- 4.0.4 — 2023-03-31
- 4.2.69 — 2023-03-31
- 4.2.0 — 2023-03-31
- … 29 more at https://npm.io/package/react-typing-animator/versions

## README

# React Typing Animator
------------

React Typing Animator is a React component for animating an array of texts like a typing sequence with blinking and a cursor. It can be used in both React and Next.js applications.

[![ezgif.com-optimize4ce54c113c3c4877.gif](https://i.postimg.cc/MH82FRdL/Screen-Recording-2024-09-02-at-5-18-35-PM.gif)](https://gifyu.com/image/SIYXV)

Installation
------------

You can install the package via npm or yarn:



```bash
npm install react-typing-animator

# or

yarn add react-typing-animator
```

Usage
-----

To use the component, import it into your project, provide an array of texts to the textArray prop, and customize the behavior and styles using other available props. Additionally, **don't forget to import the CSS file** for the component to work as intended.


```javascript
import React from 'react';
import TypingAnimator from 'react-typing-animator';
import 'react-typing-animator/styles.css';

function App() {
  const textArray = ['Welcome', 'to', 'the', 'React', 'Typing', 'Animator'];

  return (
    <TypingAnimator
      textArray={textArray}
      cursorColor="#333"
      textColor="#555"
      fontSize="24px"
      loop={false}
      typingSpeed={60}
      delaySpeed={1000}
      backspace
      height="60px"
      dynamicDelay
      displayCursor={false}
      style={{fontFamily: "Helvetica" , fontWeight: "bold", marginTop: "10px"}}
    />
  );
}

export default App;
```

Props
-----

The component accepts the following props:

| Prop Name | Type | Default Value | Description |
| --- | --- | --- | --- |
| `textArray` | string[] | `[]` | An array of texts to be animated.**This is required**|
| `loop` | boolean | true | If you need the animation to continue in a loop or stop after a single iteration.|
| `cursorColor` | string | `#000` | The color of the cursor. |
| `textColor` | string | `#000` | The color of the text. |
| `fontSize` | string | `16px` | The font size of the text. |
| `typingSpeed` | number | `200` | The speed at which the typing animation occurs, in milliseconds per character. |
| `delaySpeed` | number | `1500` | The delay between each text animation, in milliseconds. |
| `backspace` | boolean | `false` | Wether to enable the backspace behavior and animation. |
| `height` | string | `40px` |Height of the text container. |
| `dynamicDelay` | boolean | false | Adjust the delay based on the length of the current text. |
| `displayCursor` | boolean | true | Wether or not to display the cursor at the end. |
| `style` | CssProperties | {} | Add any custom style to the component.|

Features
-------

-   **Highly Customizable:** Adjust typing speed, colors, font sizes, and more.
-   **Looping Animations:** Choose whether the animation repeats indefinitely.
-   **Dynamic Delays:** Customize the delay based on text length for a natural typing effect.
-   **Backspace Support:** Enable backspace for realistic typing behavior.


Hire Me
-------

If you'd like to hire me for your project or learn more about my experience, please check out my [LinkedIn profile](https://www.linkedin.com/in/jerrythejsguy/)!

Contributing
------------
We welcome contributions! If you have ideas for new features or improvements, please open an [issue](https://github.com/J3rry320/react-typing-animator/issues) or submit a pull request.

License
-------

The React Typing Animator is released under the MIT License. See LICENSE.md for more information.

---
_Source: https://npm.io/package/react-typing-animator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
