typing-animation-anshal2/README.md

Create typing animation with just few lines of codes.

### This package let's you create a Typewritter effect with just few lines of code.

# Example

https://github.com/anshal1/writing-animation/assets/101871035/0843b91a-e090-4da4-81c3-83f843ca3c10

### If video is not available, then please check the github repo for example video

```js
npm install "typing-animation-anshal2"
```

```js
import TypeAnim from "typing-animation-anshal2";
```

# **Required Paramaters**

```js
new TypeAnim({
  // list of the words you wanna show
  wordslist: ["Word1", "Word2"],
  // the element where to show the typing animation
  element: HTMLElement,
});
```

# **Optional Paramaters**

```js
new TypeAnim({
  // list of the words you wanna show
  wordslist: ["Word1", "Word2"],
  // the element where to show the typing animation
  element: HTMLElement,
  // speed of the typing of words
  // higher the speed = higher wait time between         individual characters
  typing_speed: Number, // Default is 100ms,
  // do you want to show the cursor
  show_cursor: boolean, // Default is true
  // how long should we wait after we finish writing one word
  wait_time: Number, // Default is 1000ms
});
```