forked from jschr/textillate
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Jordan Schroter
committed
Jan 28, 2013
1 parent
4cc9636
commit e826167
Showing
4 changed files
with
107 additions
and
113 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,113 @@ | ||
Textilate.js v0.1 | ||
============= | ||
#Textilate.js v0.1 | ||
|
||
See live demo [here](http://jschr.github.com/textillate/). | ||
|
||
Textillate.js combines some awesome libraries to provide a ease-to-use plugin for applying CSS3 animations to any text. | ||
|
||
##Usage | ||
|
||
Let's start with the basic markup: | ||
|
||
```html | ||
<h1 class="tlt">My Title</h1> | ||
``` | ||
|
||
And your javascript should look like this: | ||
|
||
```js | ||
$(function () { | ||
$('.tlt').textillate(); | ||
}) | ||
``` | ||
|
||
This will animate using the default options. To change the defaults, you can either use the html data api: | ||
|
||
```html | ||
<h1 class="tlt" data-in-effect="rollIn">Tittle</h1> | ||
``` | ||
|
||
or pass in options on initialization (see full list of options below): | ||
|
||
```js | ||
$('.tlt').textillate({ in: { effect: 'rollIn' } }); | ||
``` | ||
|
||
You can also tell textillate.js to animate a list of texts with the following markup: | ||
|
||
```html | ||
<h1 class="tlt"> | ||
<ul class="texts"> | ||
<li data-out-effect="fadeOut" data-out-shuffle="true">Some Title</li> | ||
<li data-in-effect="fadeIn">Another Title</li> | ||
</ul> | ||
</h1> | ||
``` | ||
|
||
```js | ||
$('.tlt').textillate(); | ||
``` | ||
|
||
Notice that you can control the animation parameters on each text (`<li>`) using the data api. | ||
|
||
##Options | ||
|
||
```js | ||
$('.tlt').textillate({ | ||
// the default selector to use when detecting multiple texts to animate | ||
selector: '.texts', | ||
|
||
// enable looping | ||
loop: false, | ||
|
||
// sets the minimum display time for each text before it is replaced | ||
minDisplayTime: 2000, | ||
|
||
// sets the initial delay before starting the animation | ||
initialDelay: 0, | ||
|
||
// set whether or not to automatically start animating | ||
autoStart: true, | ||
|
||
// custom set of 'in' effects. This effects whether or not the | ||
// character is shown/hidden before or after an animation | ||
inEffects: [], | ||
|
||
// custom set of 'out' effects | ||
outEffects: [ 'hinge' ], | ||
|
||
// in animation settings | ||
in: { | ||
// set the effect name | ||
effect: 'fadeInLeftBig', | ||
|
||
// set the delay factor applied to each consecutive character | ||
delayScale: 1.5, | ||
|
||
// set the delay between each character | ||
delay: 50, | ||
|
||
// set to true to animate all the characters at the same time | ||
sync: false, | ||
|
||
// randomize the character sequence | ||
// (not that shuffle doesn't make sence in sync = true) | ||
shuffle: false | ||
}, | ||
|
||
// out animation settings | ||
out: { | ||
effect: 'hinge', | ||
delayScale: 1.5, | ||
delay: 50, | ||
sync: false, | ||
shuffle: false, | ||
} | ||
}); | ||
``` | ||
|
||
##Dependencies | ||
To start using textillate.js, you will need the following: | ||
|
||
* [jQuery](http://jquery.com/download/) | ||
* [lettering.js](https://github.com/davatron5000/Lettering.js) | ||
* [animate.css](https://github.com/daneden/animate.css) |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters