Skip to content

Latest commit

 

History

History
54 lines (31 loc) · 3.79 KB

README.mdown

File metadata and controls

54 lines (31 loc) · 3.79 KB
Raw

Animate.sass

Animate.sass is a Sass and Compass CSS animation library for WebKit, Firefox and beyond based on the work being done by Dan Eden in Animate.css.

The core of Animate.sass, despite being named "dot sass", is written in SCSS. Don't hate.

Installation

  1. gem install animate-sass
  2. Add require 'animate-sass' in Compass's config.rb file
  3. Then @import animate.sass (all animations)

Usage

The usage is simple, @import animate.sass (loads all animations) and have fun. All Animate.css animations are supported.

Usage examples and documentation are in the works, but until then, check out the test project for help. Animate.sass is still in development and is not intended for production UNLESS you know what you are doing. Feedback and contributions are appreciated.

Animations, a la carte ...

You may not want to load the full stack of animations from animate.sass, which emits over 5000+ lines of CSS. Instead you would like to pull in just a few animations or even a particular animation family. If that's the case, here's how to do that.

Rather than @import animate.sass (all animations), do this ...

First you need to import what's shared between all animations, @import animate/shared. Then you'll be able to import a full animation family or individual animations.

For example, if you wanted to use all the animations from the attention seekers animation family, and a few from the flippers animation family, here's what you'd do.

// Animate.sass shared stuffs
@import animate/shared

// Animate.sass animation families and individual animations
@import animate/animations/attention-seekers
@import animate/animations/flippers/flip
@import animate/animations/flippers/flipInX
@import animate/animations/flippers/flipOutX

Credits and special thanks

Huge thanks to Dan Eden on his project Animate.css. This project would not exist without his hard work. Thanks as well to Nick Pettit for his CSS3 animation library Glide.

Special thanks needs to also go out to Thoughtbot and Bourbon. I borrowed some of their CSS3 animation mixins and "tailor fit" them to my needs.

Also, I want to thank theCSSguru for kickstarting a Sass port of Animate.css. He has a page out there linking to a simple Sass conversion of Animate.css, but I wanted to do a lot more with it for the Sass community. Since it wasn't hosted on GitHub, I took the liberty to start Animate.sass and begin carving it out.

License

Copyright (c) 2011 Adam Stacoviak

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.