Giter VIP home page Giter VIP logo

taos's Introduction

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

Discord Licenese brotli bundle size


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-0',
    '!delay-0',
    'html.js :where([class*="taos:"]:not(.taos-init))'
  ]
}

Add content transform in tailwind.config.js

module.exports = {
  content: {
    transform: (content) => content.replace(/taos:/g, ''),
  },
}

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>

๐Ÿ’ก 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

taos's People

Contributors

volkandkaya avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.