1.0.6 • Published 2 years ago

my-typewriter v1.0.6

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

promo-mytypewriter

A Zero Dependency Super Lightweight Typewriter Effect JavaScript Library.

bundle size license npm release zero dependency

Features

  • Super Lightweight (Less than 1KB) 🔥
  • Easy Configuration ⚙
  • Easy Customization ⛏
  • Zero Dependencies! 🤯

CDN

We recommend you to use my-typewriter CDN for quick and easy setup.

<script src="https://cdn.jsdelivr.net/npm/my-typewriter/public/myTypewriter.min.js"></script>

Installation

You can install my-typewriter using NPM command

npm install my-typewriter

Usage/Example

Give a my-typewriter ID to an element.

<h1>
    <span id="my-typewriter"></span>
</h1>

Import and use as shown below. Also, refer to options for customizations.

import { typeWriter } from "my-typewriter";

typeWriter({
    texts: ["example 1", "example 2", "example 3"],
})

Options

NameDefaultDescription
texts Array of texts to add for typewriter effect.
letterPause1200Pause in milliseconds at end letter.
typeSpeed0Typing speed in milliseconds.
eraseSpeed100Erasing speed in milliseconds.
blinkSpeed300Cursor blink speed in milliseconds.
speed200Default typing and erasing speed, If both are set to 0.

License

license