sassy-animate

1.0.4 • Public • Published

#SassyAnimate Just-add-water CSS animation

animate.scss is a bunch of cool, fun, and cross-browser animations for you to use in your projects. Great for emphasis, home pages, sliders, and general just-add-water-awesomeness.

##Basic Usage

  1. Include the stylesheet on your document's <head>
<head>
  <link rel="stylesheet" href="/animate.min.css">
</head>
  1. Add the class animated to the element you want to animate. You may also want to include the class infinite for an infinite loop.

  2. Finally you need to add one of the following classes:

classes!

Full example:

<h1 class="animated infinite bounce">Example</h1>

Check out all the animations here!

##Usage To use animate.scss in your website, simply drop the stylesheet into your document's <head>, and add the class animated to an element, along with any of the animation names. That's it! You've got a CSS animated element. Super!

<head>
  <link rel="stylesheet" href="animate.min.css">
</head>

You can do a whole bunch of other stuff with animate.scss when you combine it with jQuery or add your own CSS rules. Dynamically add animations using jQuery with ease:

$('#yourElement').addClass('animate bounce-out-left');

You can also detect when an animation ends:

<!--
Before you make changes to this file, you should know that $('#yourElement').one() is *NOT A TYPO*

http://api.jquery.com/one/
-->

```javascript
$('#yourElement').one('webkitAnimationEnd mozAnimationEnd MSAnimationEnd oanimationend animationend', doSomething);

View a video tutorial on how to use Animate.scss with jQuery here.

Note: jQuery.one() is used when you want to execute the event handler at most once. More information here.

You can also extend jQuery to add a function that does it all for you:

$.fn.extend({
    animateCss: function (animationName) {
        var animationEnd = 'webkitAnimationEnd mozAnimationEnd MSAnimationEnd oanimationend animationend';
        $(this).addClass('animated ' + animationName).one(animationEnd, function() {
            $(this).removeClass('animated ' + animationName);
        });
    }
});

And use it like this:

$('#yourElement').animateCss('bounce');

Using Mixins

You can change the duration of your animations, add a delay or change the number of times that it plays:

  • $duration: accepts #.#s or ###ms format
  • $delay: accepts #.#s or ###ms format
  • $infinite: accepts Boolean
  • $vendor-prefix: accepts 'webkit', 'moz', 'ms', 'o', null, '*' (the * returns all vender prefixed rules)
#yourElement {
   @include fade-in-down(300ms, 2s, true, 'webkit');
}

Roadmap

  • [ ] Allow for config to be set in project root to allow for custom builds.

  • [ ] Better default configs with override options in root config.

  • [ ] Dryer mixins (timing functions can be moved out)

  • [ ] Support as Grunt task

License

Animate.scss is licensed under the MIT license. (http://opensource.org/licenses/MIT)

Readme

Keywords

none

Package Sidebar

Install

npm i sassy-animate

Weekly Downloads

6

Version

1.0.4

License

MIT

Last publish

Collaborators

  • chris_mcclellan