Skip to content

dulacp/Revealing.js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

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.

About

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

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published