mirror of
https://github.com/animate-css/animate.css.git
synced 2024-11-16 17:18:27 +01:00
71 lines
2.5 KiB
Markdown
71 lines
2.5 KiB
Markdown
#Animate.css
|
||
*Just-add-water CSS animation*
|
||
|
||
`animate.css` 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.
|
||
|
||
##Usage
|
||
To use animate.css 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!
|
||
|
||
```html
|
||
<head>
|
||
<link rel="stylesheet" href="animate.min.css">
|
||
</head>
|
||
```
|
||
|
||
You can do a whole bunch of other stuff with animate.css when you combine it with jQuery or add your own CSS rules. Dynamically add animations using jQuery with ease:
|
||
|
||
```javascript
|
||
$('#yourElement').addClass('animated bounceOutLeft');
|
||
```
|
||
|
||
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());
|
||
```
|
||
|
||
You can change the duration of your animations, add a delay or change the number of times that it plays:
|
||
|
||
```css
|
||
#yourElement {
|
||
-vendor-animation-duration: 3s;
|
||
-vendor-animation-delay: 2s;
|
||
-vendor-animation-iteration-count: infinite;
|
||
}
|
||
```
|
||
|
||
*Note: be sure to replace "vendor" in the CSS with the applicable vendor prefixes (webkit, moz, etc)*
|
||
|
||
## Custom Builds
|
||
Animate.css is powered by [Grunt](http://gruntjs.com), and you can create custom builds pretty easily. First of all, you’ll need Grunt and all other dependencies:
|
||
|
||
```sh
|
||
$ cd path/to/animate.css/
|
||
$ sudo npm install
|
||
```
|
||
|
||
Next, run `grunt watch` to watch for changes and compile your custom builds. For example, if you want only some of the the “attention seekers”, simply edit the `animate-config.json` file to select only the animations you want to use.
|
||
|
||
```javascript
|
||
"attention_seekers": {
|
||
"bounce": true,
|
||
"flash": false,
|
||
"pulse": false,
|
||
"shake": true,
|
||
"swing": true,
|
||
"tada": true,
|
||
"wobble": true
|
||
}
|
||
```
|
||
|
||
## License
|
||
Animate.css is licensed under the MIT license. (http://opensource.org/licenses/MIT)
|
||
|
||
## Contributing
|
||
Pull requests are the way to go here. I apologise in advance for the slow action on pull requests and issues. I only have two rules for submitting a pull request: match the naming convention (camelCase, categorised [fades, bounces, etc]) and let us see a demo of submitted animations in a [pen](http://codepen.io). That last one is important.
|