npm

Need private packages and team management tools?Check out npm Orgs. »

typeit

6.1.1 • Public • Published

TypeIt

The Most Versatile JavaScript Animated Typing Utility on the Planet

Build Status npm downloads Tweet

Overview

TypeIt is the most versatile JavaScript typewriter effect utility on the planet. With its simple yet flexible configuration, you're empowerd to type single or multiple strings that break lines, delete & replace each other, easily handle string containing HTML, loop, and a whole lot more.

For more advanced, controlled typing effects, TypeIt comes with companion functions that can be chained to control your typing down to a single character or millisecond, enabling you to type an dynamic narrative, with complete reign over speed changes, line breaks, deletions, and pauses.

Key Features

  • Choose to start typing only when your target element becomes visible on the screen.
  • Loop your string(s) continuously.
  • Define your strings via an options object or in the HTML (a useful fallback in case user doesn't have JavaScript enabled, as well as for SEO).
  • Use a single TypeIt instance to target several different elements on a page.
  • Handle HTML (even nested tags!) with ease, preserving all of its attributes (classes, ids, etc.).
  • Use companion functions to chain individual commands together to fine tune your typing.
  • Ready to be included via JS module, or as a separate script loaded on your page (both "legacy" and modern bundles are provided).
  • No dependencies!

License Options

Using TypeIt for an open source or personal project is completely free. To use it in a commercial project, purchase a single license, or an unlimited license that'll never expire, no matter how many times you use it.

Demos

See some more examples and try out the sandbox at https://typeitjs.com.

Documentation

All of TypeIt's documentation can be found at https://typeitjs.com/docs.

Browser Support

Bundles exist for browsers that support ES2015+ (which accounts for a very strong majority of users), as well as for those that do not. If you're using IE11 or older, you'll also need the following polyfills:

  • Array.prototype.fill
  • IntersectionObserver
  • Object.assign
  • Promise

You can load all of these yourself, or just use the following pre-made bundle from Polyfill.io:

<script src="https://polyfill.io/v3/polyfill.min.js?features=Array.prototype.fill%2CIntersectionObserver%2CObject.assign%2CPromise"></script>

Contribute

Please do! The code is available on Github. Check out the CONTRIBUTING.md file to see how to get started.

Know of a Neat Site Using TypeIt?

I'd love to see and share it! Send me a message or tweet at me.

Need Help?

If you're working with a custom implementation of TypeIt and would like some help, I'm available for hire. Get in touch!

License

GPL-2.0 © Alex MacArthur

install

npm i typeit

Downloadsweekly downloads

430

version

6.1.1

license

GPL-2.0

homepage

typeitjs.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability