https://github.com/hsynlms/autotyperjs

A vanilla javascript plugin for animated typewriting
https://github.com/hsynlms/autotyperjs

animation autotyper javascript text-animation text-effects typewriter

Last synced: about 1 month ago
JSON representation

A vanilla javascript plugin for animated typewriting

• Host: GitHub
• URL: https://github.com/hsynlms/autotyperjs
• Owner: hsynlms
• License: mit
• Created: 2018-04-20T22:56:59.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-06-08T17:15:18.000Z (over 3 years ago)
• Last Synced: 2024-09-10T18:00:54.048Z (2 months ago)
• Topics: animation, autotyper, javascript, text-animation, text-effects, typewriter
• Language: JavaScript
• Homepage: https://codepen.io/hsynlms/pen/gzapPz
• Size: 355 KB
• Stars: 13
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# AutoTyper JS

> A vanilla javascript plugin for animated typewriting.

[![Downloads](https://img.shields.io/npm/dm/autotyperjs.svg)](https://npmjs.com/autotyperjs)

[![install size](https://packagephobia.com/badge?p=autotyperjs)](https://packagephobia.com/result?p=autotyperjs)

autotyperjs can be accessable in global variable as `autoTyper`. It exposes outside two functions, `start` and `stop`. Multiple instances can be created by using `new` keyword. Its compatible with Chrome, Firefox, Safari, Internet Explorer and Edge.

- **start()** : starts AutoTyper on target element.

```javascript

  var options = {

    selector: '.content > h1',

    words: ['hello', 'world']

  }

  // start autoTyper

  var typer = new autoTyper(options)

  typer.start()

```

- **stop()** : stops AutoTyper.

```javascript

  // stop autoTyper

  typer.stop()

```

Demo on Codepen : https://codepen.io/hsynlms/pen/gzapPz

## Available options

Below options can be given to customize AutoTyper before start.

```javascript

  // available custom options

  var options = {

    selector: '.typerTarget', // target element selector

    words: [], // words/sentences that will be auto typed

    charSpeed: 85, // letter typing animation speed

    delay: 2100, // word/sentence typing animation delay

    loop: true, // if loop is activated, autoTyper will start over

    flipflop: true // if flipflop is activated, letters which are typed animated will be removed ony by one animated

  }

```

## How about blinking caret?

For better typewriting experience, blinking caret is a must. It's optional to use with autoTyper together. You only have to do is giving below styles for autoTyper target element by yourself.

The HTML side will be like:

```html



```


The CSS side will be like:

```css

@-webkit-keyframes blink-caret {

  50% {

    border-color: transparent;

  }

}

.typerTarget {

  border-right: 1px solid #404145;

  -webkit-animation: blink-caret 0.5s step-end infinite alternate;

          animation: blink-caret 0.5s step-end infinite alternate;

}

```