0.1.1 • Published 2 years ago

react-typer-component v0.1.1

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

React Typer Component

Create typewriter effect by setting up a component's children directly.

Caveat ⚠⚠⚠

This package is not production-ready, Use it with caution.

Features 🎈

  • Directly set up text inside a component
  • Allow nested elements
  • Custom cursor
  • Curstom string splitting
  • Support pasting text
  • Support pause
  • Support backspace

Install

npm install react-typer-component
# or
yarn add react-typer-component

How to use

import Typer from 'react-typer-component';

const MyComponent = () => {
  return (
    <Typer cursor={<span className="cursor">|</span>}>
      This is a typo
      <Typer.Backspace count={4} />
      <Typer.Paste>react component</Typer.Paste>
      <Typer.Pause ms={1500} />
      <div>
        use
        <div>deeper div</div>
      </div>
    </Typer>
  );
};

The final result will look like:

<div>
  This is a react component
  <div>
    use
    <div>
      deeper div
      <span className="cursor">|</span>
    </div>
  </div>
</div>