taos
v1.0.5
Published
TAOS - Tailwind CSS Animation on Scroll Library
Downloads
7,589
Maintainers
Readme
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.
Installation
Install Tailwind Plugin
Install TAOS package
npm install taos --save
Add plugin in tailwind.config.js
module.exports = {
plugins: [
require('taos/plugin')
],
}
Add safelist utilties tailwind.config.js
module.exports = {
safelist: [
'!duration-[0ms]',
'!delay-[0ms]',
'html.js :where([class*="taos:"]:not(.taos-init))'
]
}
Add content transform in tailwind.config.js
module.exports = {
content: {
relative: true,
transform: (content) => content.replace(/taos:/g, ''),
files: ['./src/*.{html,js}'],
},
}
Add JavaScript scripts
Add script in <head>
<script>document.documentElement.classList.add('js')</script>
Add the CDN script or download and paste right before the closing </body>
tag
<script src="https://unpkg.com/[email protected]/dist/taos.js"></script>
TAOS Frequently Asked Questions
Does TAOS work with React/Vue/JS frameworks
TAOS does not currently work with JS frameworks as they rerender, disable certain event listeners.
Support for them is on the road map.
💡 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: