animate.css/docsSource/sections/01-usage.md
Elton Mesquita 5a1c6b185b
v4 release (#1050)
* New animations added

* Update

* Update

* Update

* Update

* kill bower

* Turn off animations for print media query (#856)

* Add a feature to turn off animations for printing as requested.
* Add print media type
* Update the builds

* Moved away from gulp to npx + postcss

This PR changes the build system for a simpler one, using only npx as runner and postcss to process all the files.
* Solves #618
* Solves #836
* Also solves #758 just for fun ;P

* Updated travis and removed animate-config.json

* Removed strayed gulpfile and trimmed the header

* Moved prefix config to package.json and updated the tasks

* Updated travis

* Updated dependencies and postcss config

* Now using CSS custom properties

* Add css module file - solves #933

* Updated README for the new build

* Rebulit files

* Updated dependencies + added browserlist

* Fixed small typo on README

* Added imports to Back animations

* Added FadeInTopLeft.css file

Fade in the animation diagonally

* Added fadeInTopRight.css file

Fade in the animation diagonally

* Added fadeInBottomLeft.css

* Added fadeInBottomRight.css

* Added fadeOutTopLeft.css

* Added fadeOutTopRight.css

* Added fadeOutBottomRight.css

* Added fadeOutBottomLeft.css

* Added imports to diagonal fadings

* Aditional formatting

* Added diagonal fadings to README

* Fixes #966

* Animate.css v4 Updates (#1029)

* Update to v4

* Add Iteration-Count CSS utility classes solves #998

* Updated builds

* Update lightSpeed animations

* Update builds

* Fix Invalid CSS Media Query Syntax

* Update build

* Add gitpod support

* Add newline in gitpod file

* Update README

* Revert

* Declare variable

* Update builds

* Remove Gitpod support

Co-authored-by: Waren Gonzaga <warengonzaga.dev@gmail.com>

* Improves building process and package.json tidy up

* Improved animations (#901)

* Improved bounce

* Improved pulse

* Improved bounceInDown

* Improved bounceInLeft

* Improved bounceInRight

* Improved bounceInUp

* Improved bounceOutDown

* Improved bounceOuLeft

* Improved bounceOuRight

* Improved bounceOutRight

* Improved fadeInDown

* Improved fadeInDownBig

* Improved fadeInLeft

* Improved fadeInLeftBig

* Improved fadeInRightBig

* Improved fadeInUp

* Improved fadeInUpBig

* Improved fadeInRight

* Reverted fade animations

* Compiled

* Updated prefers-reduced-motion support on README

* Add .delay-1s (#982)

The .delay-1s is missing from the readme

* HTTPS relevant links on README (#972)

prevents HTTP redirects

* Create CONTRIBUTING.md (#1033)

Co-authored-by: Melek REBAI <melek.rebai89@gmail.com>
Co-authored-by: Christian Oliff <christianoliff@yahoo.com>
Co-authored-by: Daniel Eden <dan.eden@me.com>

* Updates dependencies

* Updates prettier config

* refactory transform-origin in styles

* animation shake with X and Y options 🔨

* Adds shakeX and shakeY to the build

* Set 0 Opacity to Out animation classes (#1043)

* Update issue templates

* Add 0 opacity to out classes

* Update builds

* Improved implemenation

* Update builds

* Update current readme

* Update builds

Co-authored-by: Elton Mesquita <callmeelton@gmail.com>
Co-authored-by: Waren Gonzaga <warengonzaga.dev@gmail.com>

* Removes prefix from att selector

* Feature/new demo site (#1046)

* Simplify & centralize the Animate.css home page. Finally.

* Design tweak

* Fix Lightspeed demos

* Fix Lightspeed demos (cont.)

* Trigger animation on change as well as click

* Correct jQuery example. Fixes #127

* Remove Readme on gh-pages to prevent mistakes like ee75b81

* Use animate.min.css because whatever

* Update demo page with MS animation JS hooks.

* Updating home page with rubberBand animation.

* Reverse hue animation

Red-orange-brown isn’t a great first impression.

* Add readme, use cssmin minified CSS instead of csso

* Update gh-pages

* Remove protocol from urls

Fixes Chrome’s SSL issue

* Remove Square Cash link

Donations are weird, and only US account holders could use this.

* Updating Gh-page animate.css to the current version

This is a simple commit, bringing animate.css up to date with the current master version.

* Updating Gh-page animate.min.css to reflect the current version

This is a simply update to the Animate.min.css file, to reflect the current version

* Update CSS

* Updating Gh-page index.html to the reflect the addition of zooms (in out down etc)

This adds the optgroup "zoom", and associated options of: ZoomIn, zoomOut, zoomInDown, zoomInUp, zoomInLeft, zoomInRight, zoomOutLeft, zoomOutRight, zoomOutUp, and zoomOutDown.

* refactoring index.html to mimic the current optgroup styling

I added zooms, which were absent, but added them in a way that didn't reflect the current optgroup styling and delineation. I fixed that and now exits and entrances are grouped appropriately.

* updated index.html to reflect the standard optgroup styling on sliders, added slideInDown

In addition to adding slider keyframes that were missing, I placed them into the appropriate optgroups to mimic the similar styling of the other animations.

* Merging updated version of animate.min.css

As requested, this is the updated version of animate.min.css that @daneden request I include in the pull request.

* Updated animate.min.css

Made it the new version

* added jello to options

* Update CSS

* Add jackInTheBox to gh-pages (#694)

* New Special - jackInTheBox

* copy min.css from master branch

* fixed the issue of overflow scroll (#740)

for more see this issue https://github.com/daneden/animate.css/issues/739

* Adds heartBeat animation demo (#893)

* Update animate.min.css to latest version

* Updated CSS for current browsers

* Updated animate.css

* Removed useless test folder

* Added warn about prefers-reduced-motion

* Adds docs compiler

* Adds new base template

* Improves the docs compiler

* Fixes flipOutY animation

* Updates docs template and build

* Reorder docs sections

* Updates docs animation list template

* Updates prettier ignore

* Adds syntax highlight to docs

* Small fixes to docs content

* Updates templates HTML

* Styles the demo website

* Adds functionality to demo website

* Fixes small website demo issue with medium screens

* Adds copy animation to demo site

* Renames loop classes to repeat

* Small adjusts to docs styles

* Updates docs template

* Updates docs  improving copy and adding sections

* Reviews the docs copy

* Fix some issues with demo-site

* Fixes issue with the demo-site playground

* Adjusts tooltip on demo-site

* Fix layout issues on mobile and update “close” button for animations list

Co-authored-by: Daniel Eden <dan.eden@me.com>
Co-authored-by: Matt Willis <contact@mrwillis.net>
Co-authored-by: Gabrielmtn <Gabrielmtn@gmail.com>
Co-authored-by: Indy Prieto <proforced@gmail.com>
Co-authored-by: Robert Pemberton <hellorobertp@gmail.com>
Co-authored-by: Khaled nuur <kahalidnuur@gmail.com>
Co-authored-by: Vladimir Jovanović <vladimir.jovanovic993@gmail.com>

* Updates docs folders

* Fix some small documentation issues

* Updates edit on github link

Co-authored-by: Arda Gedik <arnoldsivastanegezer@hotmail.com>
Co-authored-by: Arda Gedik <ardagedikk@hotmail.com>
Co-authored-by: Jabran Rafique <jabran.rafique@ratedpeople.com>
Co-authored-by: Waren Gonzaga <waren.gonzaga.dev@gmail.com>
Co-authored-by: Jabran Rafique️ <jabranr@users.noreply.github.com>
Co-authored-by: Vaibhav Tandon <vaibhav.tandongcet@gmail.com>
Co-authored-by: Waren Gonzaga <warengonzaga.dev@gmail.com>
Co-authored-by: Melek REBAI <melek.rebai89@gmail.com>
Co-authored-by: Christian Oliff <christianoliff@yahoo.com>
Co-authored-by: Daniel Eden <dan.eden@me.com>
Co-authored-by: Lucas Ferreira Lima <lucasferreiralimax@gmail.com>
Co-authored-by: Matt Willis <contact@mrwillis.net>
Co-authored-by: Gabrielmtn <Gabrielmtn@gmail.com>
Co-authored-by: Indy Prieto <proforced@gmail.com>
Co-authored-by: Robert Pemberton <hellorobertp@gmail.com>
Co-authored-by: Khaled nuur <kahalidnuur@gmail.com>
Co-authored-by: Vladimir Jovanović <vladimir.jovanovic993@gmail.com>
2020-05-07 16:42:33 +01:00

2.8 KiB

Installation and usage

Installing

Install with npm:

$ npm install animate.css --save

with yarn:

$ yarn add animate.css

or add it directly to your webpage using a CDN:

<head>
  <link
    rel="stylesheet"
    href="https://cdnjs.cloudflare.com/ajax/libs/animate.css/3.7.2/animate.min.css"
  />
</head>

Basic usage

After installing Animate.css, add the class animate__animated to an element, along with any of the animation names (don't forget the animate__ prefix!):

<h1 class="animate__animated animate__bounce">An animated element</h1>

That's it! You've got a CSS animated element. Super!

Animations can improve the UX of an interface, but keep in mind that they can also get in the way of your users! Please read the best practices and gotchas sections to bring your web-things to life in the best way possible.

Using @keyframes

Even though the library provides you a few helper classes like the animated class to get you up running quickly, you can use the provided animations keyframes directly. This provides a flexible way to use Animate.css with your current projects without having to refactor your HTML code.

Example:

.my-element {
  display: inline-block;
  margin: 0 0.5rem;

  animation: bounce; /* referring directly to the animation's @keyframe declaration */
  animation-duration: 2s; /* don't forget to set a duration! */
}

Be aware that some animations are dependent on the animation-timing property set on the animation's class. Changing or not declaring it might lead to unexpected results.

CSS Custom Properties (CSS Variables)

Since version 4, Animate.css makes use of custom properties (also known as CSS variables) to define the animations duration, delay, and iteractions. This makes Animate.css very flexible and customizable. Need to change an animation duration? Just set a new value to globally or locally.

Example:

/* This only changes this particular animation duration */
.animate__animated.animate__bounce {
  --animate-duration: 2s;
}

/* This changes all the animations globaly */
:root {
  --animate-duration: 800ms;
  --animation-delay: 0.9s;
}

Custom properties also make it easy to change all your animations time-constrained properties on the fly. It means that you can have a slow-motion or time-lapse effect with a javascript one-liner:

// All animations will take twice the time to accomplish
document.documentElement.style.setProperty('--animate-duration', '2s');

// All animations will take half the time to accomplish
document.documentElement.style.setProperty('--animate-duration', '.5s');

Even though custom properties are not supported by some aging browsers, Animate.css provides a proper fallback, widening its support for any browser that supports CSS animations.