------


------

Table of Contents

- Table of Contents
- Demo
- Getting started
- Installation
- Add JavaScript scripts
- TAOS Frequently Asked Questions
- JS Frameworks
- Inspiration
- Community

Demo

To view 20+ examples of TAOS in action go to versoly.com/taos.

Getting started

TAOS can be included as a plugin into an existing Tailwind CSS project and will allow you to add responsive Tailwind CSS utility classes for animation on scroll.

$3

Install the plugin from npm:
``shell
npm install taos --save
`

Then add to your main style.css file:
`css
@custom-variant taos (&.taos-init:where(:not(.taos-animate)));

html.js :where([class*="taos:"]:not(.taos-init)) {
visibility: hidden;
}

@source inline('!duration-[0ms] !delay-[0ms]');
`

If you are still using Tailwind CSS v3, add the plugin and safelist classes to your tailwind.config.js file:

`js
// tailwind.config.js
module.exports = {
theme: {
// ...
},
plugins: [
// ...
require('taos/plugin'),
],
safelist: [
'!duration-[0ms]',
'!delay-[0ms]',
'html.js :where([class*="taos:"]:not(.taos-init))',
]
}
`

$3

Add the CDN script or download and paste before the closing tag
`html


`

Add script in
`html


``

TAOS Frequently Asked Questions

$3

MutationObserver is a cleaner solution to check if the element is in view on page load and refresh. With IntersectionObserver it would require more code on top just to handle that part.

JS Frameworks

- React
- Vue

Inspiration

- AOS: is a great library and works by using custom classes such as aos-animate to animate elements.
- Tailwind: created an easy to use utility library that is easily extendable and flexible. Their variant and just in time compiler changed the game for developers.

Community

If you need help or just want to discuss about the library join the community on Github:

Discuss about Versoly on GitHub

For casual chatting with others using the library:

Join the Versoly Discord Server