Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Provides Keyframe events for CSS3 Animations

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 build
Octocat-spinner-32 compass
Octocat-spinner-32 css
Octocat-spinner-32 js
Octocat-spinner-32 CHANGELOG.md
Octocat-spinner-32 README.md
Octocat-spinner-32 demo.html
README.md

CSS3 Animation Keyframe Events

CSS3 Animations are great but the current implementation doesn't trigger Javascript Events for each Keyframe (see here for more information).

The CSSAnimation object provides the events the browser vendors left out! This allows you to bind event handlers to cssAnimationKeyframe events and perform any additional code that needs to happen at each keyframe.

Note: This won't work as well on Mobile Webkit until webkitRequestAnimationFrame() is implemented!

Tested Under

  • Safari 5
  • Chrome 12
  • Firefox 5

May/should also work for

  • iOS (see above caveat about Mobile WebKit)

Requirements

A browser capable of rendering CSS3 Animations.

Usage

Create the CSS animation keyframes in CSS as you would normally, for example with Safari/Chrome:

@-webkit-keyframes boxrotate {
  0% {
    -webkit-transform: translate3d(0, 0, 0);
    background: #da371e;
  }

  25% {
    -webkit-transform: translate3d(0px, 200px, 0) rotate(90deg);
    background: #da3ab9;
  }

  50% {
    -webkit-transform: translate3d(200px, 200px, 0) rotate(180deg);
    background: #34b6da;
  }

  75% {
    -webkit-transform: translate3d(200px, 0, 0) rotate(270deg);
    background: #88da50;
  }

  100% {
    -webkit-transform: translate3d(0, 0, 0) rotate(360deg);
    background: #da371e;
  }
}

Next trigger the animation on a specified DOM element:

var elem = document.getElementById('animateme');

// Trigger the animation named 'boxrotate' with duration 3000ms
CSSAnimation.trigger(elem, 'boxrotate', 3000);

There is also a jQuery plugin provided for convenience (cssanimation.jquery.js):

$('#animateme').cssanimation('boxrotate', 3000);

You can then listen for cssAnimationKeyframe events the same way you'd listen for any other. Here's an example using jQuery:

$('#animateme').bind('cssAnimationKeyframe', function(event){
    var text = "";

    switch(event.originalEvent.keyText) {
        case '0%':
            text = "down ↓"; break;
        case '25%':
            text = "right →"; break;
        case '50%':
            text = "up ↑"; break;
        case '75%':
            text = "left ←"; break;
        case '100%':
            text = "click me"; break;
    };

    $('#text').html(text);
});

Limitations

Currently events will only be fired for keyframes at 5% increments (e.g. 0%, 5%, 10% etc). So if you have a keyframe at 23%, you won't be notified. This is similar in design to how jQuery Runloop works.

You can change this if you want but you may begin to miss events! If you really want to change this you can by passing in an option to either the native function or jQuery plugin:

// Native
CSSAnimation.trigger(elem, 'boxrotate', 3000, {
    base: 1 // Raise events for keyframes at 1% increments
});

// jQuery
elem.cssanimation('boxrotate', 3000, {
    base: 1 // Raise events for keyframes at 1% increments
});

How does it work?

Using the requestAnimFrame() shim by Paul Irish we can get very accurate callbacks (@60fps), this means that:

The browser can optimize concurrent animations together into a single reflow and repaint cycle, leading to higher fidelity animation. For example, JS-based animations synchronized with CSS transitions.

This enables us to work out when a keyframe ought to have occured and raise a suitable event.

Contributing

Contribution is welcomed but to make it easier to accept a pull request here are some guidelines:

  • Please make all changes into the source files found under js/src. You can then use the build tool (PHP script found at ./build/build) to create the concatenated and minified files.

  • Please camelCase your variables, especially if they are used in the options object.

License

CSSAnimation Keyframe Events is Copyright © 2011 Joe Lambert and is licensed under the terms of the MIT License.

Something went wrong with that request. Please try again.