https://github.com/alexprut/textshuffle.js

A jQuery plugin for text shuffling (alike the airport terminal).
https://github.com/alexprut/textshuffle.js

airport-terminal javascript jquery-plugin

Last synced: 6 months ago
JSON representation

A jQuery plugin for text shuffling (alike the airport terminal).

• Host: GitHub
• URL: https://github.com/alexprut/textshuffle.js
• Owner: alexprut
• License: mit
• Created: 2016-09-20T14:05:47.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2020-06-08T16:59:51.000Z (over 5 years ago)
• Last Synced: 2025-02-11T03:01:47.978Z (11 months ago)
• Topics: airport-terminal, javascript, jquery-plugin
• Language: JavaScript
• Homepage:
• Size: 178 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
TextShuffle.js

==============  

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) [![MIT](https://img.shields.io/dub/l/vibe-d.svg)](https://github.com/alexprut/TextShuffle.js/blob/master/LICENSE)  

> A jQuery plugin for text shuffling (alike the airport terminal).

##  Demo

![Demo 1](https://github.com/alexprut/TextShuffle.js/raw/master/examples/demo-randombynary.gif)

![Demo 2](https://github.com/alexprut/TextShuffle.js/raw/master/examples/demo-randomchars.gif)

##  Install

```

bower install textshuffle.js --save

```

##  Usage

```javascript

$('#demo').textShuffle({chars: '1010'});

```

or

```javascript

var shuffle = $('#demo').textShuffle();

shuffle.setChars('1010');

```

#### Parameters

|Name|Type|Description|Default|

|----|----|-----------|-------|

|```chars```|```string```|the character to be used during the shuffle|"01#/&%$?\_-%\*"|

|```animationSpeed```|```int```|the animation speed in milliseconds|10|

|```bindEvent```|```string```|the event to bind (e.g. click, mouseenter, mouseleave, ...)|'mouseover'|

#### Methods

|Name|Parameters Type|Description|

|----|----|-----------|

|```setChars(newChars)```|```string```|the character to be used during the shuffle|

|```setAnimationSpeed(newSpeed)```|```int```|the animation speed in milliseconds|

|```play()```||triggers the shuffle animation|

##  License

Licensed under [MIT](https://github.com/alexprut/TextShuffle.js/blob/master/LICENSE).