GitXplorerGitXplorer
g

wowjs.uk

public
3 stars
6 forks
1 issues

Commits

List of commits on branch master.
Unverified
f89e85cf8fe598cfbc876e999db59ae5a5412d40

Merge branch 'gh-pages' of github.com:graingert/WOW

ggraingert committed 8 years ago
Unverified
192eba274df72b407b0e226bd2128df0ed97d922

add keywords

ggraingert committed 8 years ago
Unverified
3a4a0c60d6ed908bc484df0e553c0050519d4a13

Merge branch 'gh-pages' of github.com:graingert/WOW

ggraingert committed 8 years ago
Unverified
15bd6795c868c9d4b52dfc15ed82652f0fe281cb

remove h1's default margin

ggraingert committed 8 years ago
Unverified
3f3ed87e6089039ee844a991a8912cffcedc6a9c

Merge branch 'gh-pages' of github.com:graingert/WOW

ggraingert committed 8 years ago
Unverified
e72a3c6fbf8078e4a6cfee6d1a0e1624f217e68b

restore span2, format spiel like h2

ggraingert committed 8 years ago

README

The README file for this repository.

WOW.js Build Status

Reveal CSS animation as you scroll down a page. By default, you can use it to trigger animate.css animations. But you can easily change the settings to your favorite animation library.

Advantages:

  • 100% MIT Licensed, not GPL keep your code yours.
  • Naturally Caffeine free
  • Smaller than other JavaScript parallax plugins, like Scrollorama (they do fantastic things, but can be too heavy for simple needs)
  • Super simple to install, and works with animate.css, so if you already use it, that will be very fast to setup
  • Fast execution and lightweight code: the browser will like it ;-)
  • You can change the settings - see below

Live examples

Documentation

It just take seconds to install and use WOW.js! Read the documentation ➫

Dependencies

Installation

  • Bower
   bower install wow-mit
  • NPM
   npm install wow.js

Basic usage

  • HTML
  <section class="wow slideInLeft"></section>
  <section class="wow slideInRight"></section>
  • JavaScript
new WOW().init();

Advanced usage

  • HTML
  <section class="wow slideInLeft" data-wow-duration="2s" data-wow-delay="5s"></section>
  <section class="wow slideInRight" data-wow-offset="10"  data-wow-iteration="10"></section>
  • JavaScript
var wow = new WOW(
  {
    boxClass:     'wow',      // animated element css class (default is wow)
    animateClass: 'animated', // animation css class (default is animated)
    offset:       0,          // distance to the element when triggering the animation (default is 0)
    mobile:       true,       // trigger animations on mobile devices (default is true)
    live:         true,       // act on asynchronously loaded content (default is true)
    callback:     function(box) {
      // the callback is fired every time an animation is started
      // the argument that is passed in is the DOM node being animated
    },
    scrollContainer: null // optional scroll container selector, otherwise use window
  }
);
wow.init();

Asynchronous content support

In IE 10+, Chrome 18+ and Firefox 14+, animations will be automatically triggered for any DOM nodes you add after calling wow.init(). If you do not like that, you can disable this by setting live to false.

If you want to support older browsers (e.g. IE9+), as a fallback, you can call the wow.sync() method after you have added new DOM elements to animate (but live should still be set to true). Calling wow.sync() has no side effects.

Contribute

The library is transpiled using Babel, please update wow.js file.

We use grunt to compile and minify the library:

Install needed libraries

npm install

Get the compilation running in the background

grunt watch

Enjoy!

Bug tracker

If you find a bug, please report it here on Github!

Developer

Originally Developed by Matthieu Aussaguel, mynameismatthieu.com Forked to remain under the MIT license by Thomas Grainger, https://graingert.co.uk

Contributors

Thanks to everyone who has contributed to the project so far:

Initiated and designed by Vincent Le Moign, @webalys