GitHub - dulaccc/Revealing.js: Reveal your text with a delightful letter by letter animation. Inspired by the Secret app.

Revealing.js

Reveal your text with a delightful letter by letter animation.

Inspired by the Secret app.

Examples

Getting Started

Install from Bower (recommended)

bower install Revealing.js

Development version

Build compiled version from sources

3 simple steps:

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

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

Integration

In your web page:

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

<body>
    <span class="fancy-text">"Je suis jeune il est vrai mais aux &acirc;mes bien n&eacute;es la valeur n'attend point le nombre des ann&eacute;es" Le Cid -  Corneille</span>
</body>

<script>
document.addEventListener('DOMContentLoaded', function() {
  // initialize the plugin
  var el = document.querySelector('.fancy-text');
  var reveal = new Revealing(el);

  // delay the animation just a little bit
  setTimeout(function() {
    reveal.show();
  }, 150);

});
</script>

Documentation

show
Reveal the text

reset
Reset the text to play the animation again

Contact

Pierre Dulac
@dulaccc

License

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

Failed to load latest commit information.
examples	Refactor the hiding process integrated from the #4	Jun 21, 2015
src	Refactor the hiding process integrated from the #4	Jun 21, 2015
.bowerrc	Initial commit :)	Jun 21, 2014
.gitignore	Include the dist into the repo	Jun 21, 2015
.jshintrc	Initial commit :)	Jun 21, 2014
LICENSE	Add the MIT License	Jun 24, 2014
README.md	Remove the test references	Jun 21, 2015
bower.json	Bump version 1.0.0	Jun 21, 2015
gulpfile.js	Use gulp clean for not inserting bad things into the dist	Jun 21, 2015
package.json	Bump version 1.0.0	Jun 21, 2015

dulaccc/Revealing.js

README.md