jcsaaddupuy / Revealing.js

Reveal your text with a delightful letter by letter animation. Inspired by the Secret app.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Revealing.js

Reveal your text with a delightful letter by letter animation.

Inspired by the Secret app.

Text animation example

Examples

Check out some basic examples

Getting Started

Install from Bower (recommended)

bower install Revealing.js

Grab compiled version for production

Grab development version

Build from sources

3 simple steps:

  • clone git clone https://github.com/dulaccc/Revealing.js.git && cd Revealing.js
  • install dependencies npm install
  • build grunt build

Then you'll find the compiled code in dist/.

Integration

In your web page:

<script src="jquery.js"></script>
<script src="dist/revealing.min.js"></script>
<link rel="stylesheet" href="dist/revealing.css"></script>

<script>
jQuery(function($) {
  // initialize the plugin
  $('.fancy-text').revealing();

  // delay the animation just a little bit
  setTimeout(function() {
  	$('.fancy-text').revealing('show');
  }, 150);
});
</script>

Documentation

Coming soon

Contact

Pierre Dulac
@dulaccc

License

Revealing.js is available under the MIT license. See the LICENSE file for more info.

About

Reveal your text with a delightful letter by letter animation. Inspired by the Secret app.

License:MIT License