Skip to content

Latest commit

 

History

History
70 lines (50 loc) · 1.59 KB

README.md

File metadata and controls

70 lines (50 loc) · 1.59 KB
Raw

Logo

Typewriter.js

Typewriting utility for JavaScript

Navigation

Description

Typewriter.js is your on-the-go, virtual typewriter that offers an easy and hackable way of producing and maintaining typewriter-like animations on text.

Installation

npm

npm install eo-typewriterjs

yarn

yarn add eo-typewriterjs

cdn

https://cdn.jsdelivr.net/npm/eo-typewriterjs@latest/dist/typewriter.js

Building

  1. Clone the GitHub repository https://github.com/EOussama/typewriterjs.git.
  2. Run npm install to install all the dependencies.
  3. Run npm run build to build the package.
  4. The production script will be placed in the dist folder.

Usage

The following example types the string “Hello, world!”:

index.html

<div id="target"></div>

script.js

var tw = new Typewriter("#target");
tw.type("Hello, world!").start();