Skip to content

matthewmueller/typewriter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

typewriter

animated typing

Example

animated

typewriter('#typewriter', 'Hello world!').start();

Installation

$ component install matthewmueller/typewriter

Events

  • end : emitted when typewriter finishes
  • start : emitted when typewriter starts typing
  • stop : emitted when we manually stop typewriter
  • restart : emitted when we manually restart typewriter

API

typewriter(el, str, [delay])

Initialize Typewriter on a given el, with the string str and delay. If no delay is specified, it defaults to 100.

typewriter('#header', 'Hello world!', 200);

#start()

Start the typewriter

typewriter.start()

#stop()

Stop the typewriter

typewriter.stop()

#restart()

Restart the typewriter. Clears the input

typewriter.restart()

#clear()

Clear the typewriter input

typewriter.clear();

License

MIT