simple-aos


`

See full list of all animations, easings and anchor placements

#### Anchor

There is also a setting that can be used only on per-element basis:

- data-aos-anchor - element whose offset will be used to trigger animation instead of an actual one.

Examples:

`html



`

This way you can trigger animation on one element, while you scroll to another - useful in animating fixed elements.

---

API

AOS object is exposed as a global variable, for now there are three methods available:

- init - initialize AOS
- refresh - recalculate all offsets and positions of elements (called on window resize)
- refreshHard - reinit array with AOS elements and trigger refresh (called on DOM changes that are related to aos elements)

Example execution:

`js
AOS.refresh();
`

By default AOS is watching for DOM changes and if there are any new elements loaded asynchronously or when something is removed from DOM it calls refreshHard automatically. In browsers that don't support MutationObserver like IE you might need to call AOS.refreshHard() by yourself.

refresh method is called on window resize and so on, as it doesn't require to build new store with AOS elements and should be as light as possible.

---

JS Events

AOS dispatches two events on document: aos:in and aos:out whenever any element animates in or out, so that you can do extra stuff in JS:

`js
document.addEventListener("aos:in", ({ detail }) => {
console.log("animated in", detail);
});

document.addEventListener("aos:out", ({ detail }) => {
console.log("animated out", detail);
});
`

You can also tell AOS to trigger custom event on specific element, by setting data-aos-id attribute:

`html



`

Then you'll be able to listen for two custom events then:

- aos:in:super-duper
- aos:out:super-duper

---

Recipes:

#### Adding custom animations:

Sometimes built-in animations are just not enough. Let's say you need one box to have different animation depending on resolution.
Here's how you could do it:

`css
[data-aos="new-animation"] {
opacity: 0;
transition-property: transform, opacity;

&.aos-animate {
opacity: 1;
}

@media screen and (min-width: 768px) {
transform: translateX(100px);

&.aos-animate {
transform: translateX(0);
}
}
}
`

Then use it in HTML:

`html



`

The element will only animate opacity on mobile devices, but from 768px width it'll also slide from right to left.

#### Adding custom easing:

Similar to animations you can add custom easings:

`css
[data-aos] {
body[data-aos-easing="new-easing"] &,
&[data-aos][data-aos-easing="new-easing"] {
transition-timing-function: cubic-bezier(0.25, 0.25, 0.75, 0.75);
}
}
`

#### Customizing default animations distance

Default distance for built-in animations is 100px. As long as you're using SCSS though, you can override it:

`css
$aos-distance: 200px; // It has to be above import
@import "node_modules/aos/src/sass/aos.scss";
`

You have to however configure your build process to allow it to import styles from node_modules beforehand.

#### Integrating external CSS animation library (e.g. Animate.css):

Use animatedClassName to change default behaviour of AOS, to apply class names placed inside data-aos on scroll.

`html



`

`js
AOS.init({
useClassNames: true,
initClassName: false,
animatedClassName: "animated",
});
`

The above element will get two classes: animated and fadeInUp. Using different combinations of the three above settings, you should be able to integrate any external CSS animation library.

External libraries however don't care too much about animation state before the actual animation. So if you want those elements to be not visible before scrolling, you might need to add similar styles:

`css
[data-aos] {
visibility: hidden;
}
[data-aos].animated {
visibility: visible;
}
`

---

Caveats:

#### setting: duration, delay

Duration and delay accept values from 50 to 3000, with step 50ms, it's because those are handled by css, and to not make css longer than it is already I implemented only a subset. I believe those should cover most cases.

If not, you can write simple CSS that will add another duration, for example:

`css
body[data-aos-duration="4000"] [data-aos],
[data-aos][data-aos][data-aos-duration="4000"] {
transition-duration: 4000ms;
}
`

This code will add 4000ms duration available for you to set on AOS elements, or to set as global duration while initializing AOS script.
Notice that double [data-aos][data-aos] - it's not a mistake, it is a trick, to make individual settings more important than global, without need to write ugly "!important" there :)

Example usage:

`html



``

---

Predefined options

$3

- Fade animations:

- fade
- fade-up
- fade-down
- fade-left
- fade-right
- fade-up-right
- fade-up-left
- fade-down-right
- fade-down-left

- Flip animations:

- flip-up
- flip-down
- flip-left
- flip-right

- Slide animations:

- slide-up
- slide-down
- slide-left
- slide-right

- Zoom animations:
- zoom-in
- zoom-in-up
- zoom-in-down
- zoom-in-left
- zoom-in-right
- zoom-out
- zoom-out-up
- zoom-out-down
- zoom-out-left
- zoom-out-right

$3

- top-bottom
- top-center
- top-top
- center-bottom
- center-center
- center-top
- bottom-bottom
- bottom-center
- bottom-top

$3

- linear
- ease
- ease-in
- ease-out
- ease-in-out
- ease-in-back
- ease-out-back
- ease-in-out-back
- ease-in-sine
- ease-out-sine
- ease-in-out-sine
- ease-in-quad
- ease-out-quad
- ease-in-out-quad
- ease-in-cubic
- ease-out-cubic
- ease-in-out-cubic
- ease-in-quart
- ease-out-quart
- ease-in-out-quart

---

❔Questions

If you found a bug, have a question or an idea, please check Simple AOS contribution guide and don't hesitate to create new issues.