https://github.com/awran5/typewriting

Lightweight JavaScript plugin for adding nice, customizable Typewriting effect using custom HTML5 attributes.
https://github.com/awran5/typewriting

es6 html5-attribute lightweight-javascript-plugin typewriter-effect typewriting

Last synced: 13 days ago
JSON representation

Lightweight JavaScript plugin for adding nice, customizable Typewriting effect using custom HTML5 attributes.

• Host: GitHub
• URL: https://github.com/awran5/typewriting
• Owner: awran5
• License: mit
• Created: 2018-10-01T13:59:20.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2018-10-25T05:44:28.000Z (about 6 years ago)
• Last Synced: 2024-10-12T10:09:18.129Z (27 days ago)
• Topics: es6, html5-attribute, lightweight-javascript-plugin, typewriter-effect, typewriting
• Language: JavaScript
• Homepage:
• Size: 83 KB
• Stars: 1
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# TypeWriting

TypeWriting is a tiny lightweight JavaScript plugin for adding nice, customizable Typewriting effect using custom HTML5 attributes. This plugin is written in native JavaScript ES6 and does not requires any dependencies!

Inspired by [TraversyMedia](https://www.traversymedia.com/). I've made some changes and modifications to suit my needs, if you have an issue/idea, please feel free to fork the repo or send me a push request and i'll be happy to push it.

## Usage

1. Load the minified version `typewriting.min.js` by placing the script tag before the closing Body tag for better page speed performance.

```html

```

2. Create an empty `span` tag with class name `typewrite`. You're able to pass the options using the custom HTML5 attributes:

- **data-loop:** Stop the typing loop. Value shoud be `yes` or `no`

- **data-speed:** Typing speed in millisecond. Default value is `100`

- **data-delay:** Time delay after word is complete in millisecond. Default value is `1000`

- **data-words:** Words to add separated by comma i.e. `["...","...","..."]`

```html

Hey, I'm

    



```

## [Demo](https://awran5.github.io/typewriting/)