https://github.com/versoly/taos

Tailwind CSS Animation on Scroll - A simple and small (600 bytes) library to help animate elements while scrolling using responsive Tailwind CSS JIT utility classes.
https://github.com/versoly/taos

animation-on-scroll tailwindcss

Last synced: 5 days ago
JSON representation

Tailwind CSS Animation on Scroll - A simple and small (600 bytes) library to help animate elements while scrolling using responsive Tailwind CSS JIT utility classes.

• Host: GitHub
• URL: https://github.com/versoly/taos
• Owner: versoly
• License: mit
• Created: 2022-06-08T04:02:12.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-20T04:19:12.000Z (about 1 month ago)
• Last Synced: 2024-12-06T22:35:59.110Z (20 days ago)
• Topics: animation-on-scroll, tailwindcss
• Language: JavaScript
• Homepage: https://versoly.com/taos
• Size: 521 KB
• Stars: 247
• Watchers: 4
• Forks: 8
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


  
TAOS

  
Tailwind CSS Animation on Scroll - A simple and small (600 bytes) library to help animate elements while scrolling using responsive Tailwind CSS utility classes. React & Vue supported.


  


      

      

      

          

      

  



------

[![Versoly - Tailwind page builder](public/versoly.png)](https://versoly.com/tailwind-page-builder?utm_source=github&utm_medium=repo&utm_campaign=image&utm_term=taos)

## Demo

To view 20+ examples of TAOS in action go to [versoly.com/taos](https://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

```js

npm install taos --save

```

Add plugin in `tailwind.config.js`

```js

module.exports = {

  plugins: [

    require('taos/plugin')

  ],

}

```

Add safelist utilties `tailwind.config.js`

```js

module.exports = {

  safelist: [

    '!duration-[0ms]',

    '!delay-[0ms]',

    'html.js :where([class*="taos:"]:not(.taos-init))'

  ]

}

```

Add content transform in `tailwind.config.js`

```js

module.exports = {

  content: {

    relative: true,

    transform: (content) => content.replace(/taos:/g, ''),

    files: ['./src/*.{html,js}'],

  },

}

```

### Add JavaScript scripts

Add script in ``

```html

document.documentElement.classList.add('js')

```

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

```html

```

## TAOS Frequently Asked Questions

### TAOS doesn't work for my use case can you add custom code just for me?

No, the goal of TAOS is to be as small as possible while providing the most functionality. We're looking into creating taos/core that would make it easy to plug into for custom use cases.

### Why do you use MutationObserver instead of IntersectionObserver

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](https://github.com/versoly/taos/tree/main/packages/react)

- [Vue](https://github.com/versoly/taos/tree/main/packages/vue)

## 💡 Inspiration

- [AOS](https://github.com/michalsnik/aos): is a great library and works by using custom classes such as aos-animate to animate elements.

- [Tailwind](https://tailwindcss.com/): 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](https://github.com/versoly/taos/discussions)

For casual chatting with others using the library:

[Join the Versoly Discord Server](https://discord.versoly.com)