https://github.com/damian-guh/react-typing-text-animation

Simple typing text animation in React
https://github.com/damian-guh/react-typing-text-animation

react to-portfolio

Last synced: 28 days ago
JSON representation

Simple typing text animation in React

• Host: GitHub
• URL: https://github.com/damian-guh/react-typing-text-animation
• Owner: damian-guh
• Created: 2021-04-05T15:48:15.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-02-01T23:03:33.000Z (almost 2 years ago)
• Last Synced: 2024-10-31T19:56:05.243Z (about 2 months ago)
• Topics: react, to-portfolio
• Language: JavaScript
• Homepage:
• Size: 10.3 MB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# react-typing-text-animation

> Simple typing text animation in React component

[![NPM](https://img.shields.io/npm/v/react-typing-text-animation.svg)](https://www.npmjs.com/package/react-typing-text-animation)

## Install

```bash

npm install react-typing-text-animation

```

## Usage

```jsx

import TypingTextAnimation from 'react-typing-text-animation'

import 'react-typing-text-animation/dist/index.css' // only if you're using default cursor

function Example() {

  return 

}

```

## API

|      Property      |                 Type                  |     Default      | Required |

| :----------------: | :-----------------------------------: | :--------------: | :------: |

|        text        |                string                 |        ""        |   yes    |

|     className      |                string                 |        ""        |    no    |

|       delay        |              number (ms)              |       200        |    no    |

|   cursorDuration   | string (css animation-duration value) |       "1s"       |    no    |

|      reverse       |                 bool                  |      false       |    no    |

|   delayOnReverse   |              number (ms)              |        50        |    no    |

| brakeBeforeReverse |              number (ms)              |       2500       |    no    |

|       cursor       |             React Element             | cursor component |    no    |

## License

MIT © [ThisGuh](https://github.com/ThisGuh)