Package Exports

animateme

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (animateme) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Animate Me

Animate DOM Elements when they enter the browser viewport

Usage

In your HTML create the elements that you want to animated. The default classname is animated.

import AnimateMe from 'animateme/src/animate.me.js';

new AnimateMe();

If you wish to use the defaults, make sure to add the css file, or code your own.

Options

Set your own classname for the animated element when in viewport. Remember to update animated.css too!

animatedIn: 'animated-in'
Set the animation delay in pixels via "data-offset" attribute. You can change this attrubute in the options.

data-offset="120"
Choose to run the animations on mobile devices (tablets and phones)

mobileDisabled: true
Choose the start point of the animation relatively to the viewport.

offset: 0.8

0.8 means that the animation will start when the top of the element is at 80% from the top of the viewport

This number should be between 0 and 1.
Choose whether to run the animation again as you scroll up and then down

reverse: false
Optionally, you can use an external library such as animates.css. If you choose to do so make sure that you add the animation name in the data-animation attribute of your DOM element. You can modify this attribute's name in the options.

Supported Browsers

All browsers which know CSS transitions are supported.

IE9 and below will simply ignore the transitions and show the content as is.

Just remember to add all vendor prefixes, just in case :)

Example setup:

new AnimateMe('.animated', {
  offset: 0.5,
  reverse: true,
  animatedIn: 'animate-me--in',
  offsetAttr: 'data-offset',
  animationAttr: 'data-animation',
  mobileDisabled: true
})