https://github.com/maikenegreiros/react-typerighter

A React Component that makes a cool typing effect
https://github.com/maikenegreiros/react-typerighter

Last synced: 4 days ago
JSON representation

A React Component that makes a cool typing effect

• Host: GitHub
• URL: https://github.com/maikenegreiros/react-typerighter
• Owner: maikenegreiros
• Created: 2020-04-22T01:27:49.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T04:02:34.000Z (almost 2 years ago)
• Last Synced: 2023-03-21T01:38:47.835Z (over 1 year ago)
• Language: JavaScript
• Size: 2.05 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 16
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# react-typerighter

A React Component that makes a cool typing effect

## Usage

React TypeRighter is very simple to use

### Props

Only one of the props is required, the rest of them is optional

1. **text**: _string_ | _required_

2. **color**: _string_

3. **fontSize**: _string_

4. **fontFamily**: _string_

5. **blinkTime**: _number_

6. **typingTime**: _number_

### Example

Here is an example using all the props

```js

import TypeRighter from "react-typerighter";

function MyComponent() {

  return (

    

  );

}

```

![TypeRighter Example: A text being typed in the screen](https://raw.githubusercontent.com/maikenegreiros/react-typerighter/master/public/images/typist-example.gif)

## Development

If you want to contribute to this project, you have to compile the project in development mode:

```bash

npm run dev

```

By running the previous command, webpack will compile code in develpment mode and will watch the files changes