writing-animation

Animation of writing letter by letter

Stats

StarsIssuesVersionUpdatedCreatedSize
writing-animation
001.1.13 years ago4 years agoMinified + gzip package size for writing-animation in KB

Readme

WritingAnimation

writing animation is a function that simulates writing as typing

How to use

Browser

<script src="https://cdn.jsdelivr.net/npm/writing-animation/dist/writing-animation.min.js" ></script>

Server

Using with browserify

npm install --save writing-animation

ES5

var writing = require('writing-animation');

ES6

import writing from 'writing-animation';

Using

writing(text, textContainer, delay [,stop, changeDelay]);

Parameters

text : The text that you want to animate.

textContainer : The element of the DOM where you want to write the text.

delay : The time in milliseconds to write a letter of the text.

Optional

stop : A boolean value for stop the animation when the text was write.

changeDelay : The time in milliseconds between the writing animation.

Only For browsers

Set elements container with the class "writing-animation"

Data attributes:

data-anim-text: The text parameter.

data-anim-delay: The delay parameter.

data-anim-stop: The stop parameter.

data-anim-change: The changeDelay parameter.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.