README.md

Typed Textfield

This is a simple and customizable react component that simulates typing

Installation

To add this library to your project, run the following command:

npm i typed-textfield

Usage

In order to use this component, simply import it as shown below:

import { TypedText } from 'typed-texfield'

Now, you can use it inside your react component:

function MyComponent(props) {
  return (
    <div>
      <TypedText
        sentences={['Hello world, I am working', 'I am also working with a new sentence!']}
        style={{ fontFamily: 'monospace' }}
      />
    </div>
  )
}

Properties

sentences: string[] - an array of strings representing the sentences that will interchangably be typed onto the screen.

style?: CSSProperties - any style that you would like the text component to have.

loop?: boolean - whether the sentences should repeat after the final one is reached. Default is false.

typeTime?: number - the time in milliseconds it takes to type a new character. Default is 40.

waitTime?: number - the time in milliseconds waited before a deletion of a sentence begins. Default is 1200.

deleteTiime?: number - the time in milliseconds necessary to delete a single character. Default is 8.