jquery-aniview's Introduction

jQuery AniView

A jQuery plugin that works in harmony with animate.css in order to enable animations only when content comes into view.

Demo

http://jjcosgrove.github.io/jquery-aniview/

Initialisation

$('.aniview').AniView();

Options

var options = {
    animateThreshold: 100,
    scrollPollInterval: 50
}
$('.aniview').AniView(options);

Option	Type	Description	Default
animateThreshold	int	+ve numbers delay the animation sequence until the specified number pixels have come into view. -ve numbers will trigger the animation sequence prior to the element coming into view.	0
scrollPollInterval	int	The frequency at which the user scrolling is 'polled' i.e. tested. This is in milliseconds (ms) and is an extension jQuery's in-built 'scroll' event/handler.	20

Markup

<div class="aniview" av-animation="slideInRight"></div>

Full Example

A typical working example (minimal) might look something like this:

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>My AniView Page</title>
    <link type="text/css" rel="stylesheet" href="animate.css">
    <script type="text/javascript" src="jquery.min.js"></script>
    <script type="text/javascript" src="jquery.aniview.min.js"></script>
    <script>
        $(document).ready(function(){
            $('.aniview').AniView();
        });
    </script>
</head>
<body>
    <div>
        <p class="aniview" av-animation="slideInRight">
            This is my awesome animated element!
        </p>
    </div>
</body>
</html>

Notes

Any element already in the viewport when the user loads the page will have it's animation triggered imediately if one has been set. In other words, it will not wait for the user to begin scrolling before initiating the animation on these elements.