Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 3.42 KB

README.md

File metadata and controls

67 lines (46 loc) · 3.42 KB
Raw

react-hot-typer

A light component that simulates typing and deleting your text, without any dependencies.

GIF demo

Getting Started

First to install the library, run:

$ npm install react-hot-typer --save

OR (if you prefer yarn)

$ yarn add react-hot-typer

Then you can use it with your components:

import HotTyper from 'react-hot-typer';

const AnimatedText = () => {
  return (
    <div style={{ fontSize: 18, fontFamily: '"Comic Sans MS", cursive, sans-serif' }}>
      <HotTyper
        text={[
          'Make your text animated',
          'Make your text elegent',
          'Make your text stylish',
          'Make your text stylish with ZERO effort from you ;).'
        ]}
      />
    </div>
  );
}

Props

The props you may want to specify:

Name Type Default value Description
text * string OR array<string> --- Text(s) that will simulated, Note: If an array is provided, only the difference between each element and the next one is deleted, common text is spared.
hideCursorOnEnd boolean true Whether to hide the cursor when the all the text(s) is done or not.
speedOfLoop number 1100 The waiting time between the end of one text element and the next one (only relevent if an array is provided to text prop) in ms.
typingRate number 100 The waiting time between typing each character in ms.
cursor string OR node 'I' Cursor react node or string to render.
cursorFlashRate number 200 The waiting time between hiding the cursor and showing it again (Cursor flashing) in ms.
initialDelay number 800 The waiting time before only the first text starts to be typed in ms.
highlightDuration number 150 The time each to-be-deleted text remains highlighted (with blue background) in ms.

(*) required

Contributing

Please read CONTRIBUTING file for details on our code of conduct, and the process for submitting pull requests to us.

Authors

License

This project is licensed under the MIT License - see the LICENSE file for details