jtypey.js
v0.1.0
Published
A lightweight JavaScript library for printing text using a typewriter effect.
Downloads
11
Maintainers
williamtroupReadme
- Zero-dependencies and extremely lightweight!
- Full API available via public functions.
- Fully configurable!
- Fully configurable per element!
- Typewriter effects allow you to type and delete.
- Repeat always, or any number of times.
All modern browsers (such as Google Chrome, FireFox, and Opera) are fully supported.
To see a list of all the most recent changes, click here.
To get started using Typey.js, do the following steps:
1. Prerequisites:
Make sure you include the "DOCTYPE html" tag at the top of your HTML, as follows:
<!DOCTYPE html>2. Include Files:
<script src="dist/typey.js"></script>3. DOM Element Binding:
<div data-typey-options="{ 'speed': 100 }">
<p>This is some example text that should be typed out.</p>
</div>To see a list of all the available binding options you can use for "data-typey-options" click here.
To see a list of all the available custom triggers you can use for "data-typey-options" click here.
4. Finishing Up:
That's it! Nice and simple. Please refer to the code if you need more help (fully documented).
To customize, and get more out of Typey.js, please read through the following documentation.
1. Public Functions:
To see a list of all the public functions available, click here.
2. Configuration:
Configuration options allow you to customize how Typey.js will function. You can set them as follows:
<script>
$typey.setConfiguration( {
safeMode: false
} );
</script>To see a list of all the available configuration options you can use, click here.