Socket
Socket
Sign inDemoInstall

tailwindcss-animated

Package Overview
Dependencies
Maintainers
0
Versions
6
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

tailwindcss-animated

Extended animation utilities for Tailwind CSS


Version published
Weekly downloads
32K
increased by4.69%
Maintainers
0
Weekly downloads
 
Created
Source

Tailwind CSS Animated

Extended animation utilities for Tailwind CSS
https://tailwindcss-animated.com

Installation

Install the plugin from npm:

npm i tailwindcss-animated

Then add the plugin to your tailwind.config.js file:

// tailwind.config.js
module.exports = {
  // ...
  plugins: [
    require('tailwindcss-animated')
  ],
}

Usage

This plugin brings various utility classes as well as several ready-to-use CSS animations. Here are some simple examples:

<button class="animate-wiggle">
  Hej, look at me!
</button>

<button class="animate-jump-in animate-delay-300 animate-once">
  Wait a bit, then jump right in.
</button>

Ready-to-use animations

There are several animations that can be integrated with a single utility class. These extend the Spin, Ping and Pulse animations of Tailwind CSS.

Open the configurator to see them in action:
https://tailwindcss-animated.com/configurator.html

All animations can be customized with the utility classes below.

Duration

ClassProperties
animate-duration-75animation-duration: 75ms;
animate-duration-100animation-duration: 100ms;
animate-duration-150animation-duration: 150ms;
animate-duration-200animation-duration: 200ms;
animate-duration-300animation-duration: 300ms;
animate-duration-500animation-duration: 500ms;
animate-duration-700animation-duration: 700ms;
animate-duration-1000animation-duration: 1000ms;
animate-duration-[5s] *animation-duration: 5s;

Delay

ClassProperties
animate-delay-noneanimation-delay: 0ms;
animate-delay-75animation-delay: 75ms;
animate-delay-100animation-delay: 100ms;
animate-delay-150animation-delay: 150ms;
animate-delay-200animation-delay: 200ms;
animate-delay-300animation-delay: 300ms;
animate-delay-500animation-delay: 500ms;
animate-delay-700animation-delay: 700ms;
animate-delay-1000animation-delay: 1000ms;
animate-delay-[5s] *animation-delay: 5s;

Direction

ClassProperties
animate-normalanimation-direction: normal;
animate-reverseanimation-direction: reverse;
animate-alternateanimation-direction: alternate;
animate-alternate-reverseanimation-direction: alternate-reverse;

Iteration Count

ClassProperties
animate-infiniteanimation-iteration-count: infinite;
animate-onceanimation-iteration-count: 1;
animate-twiceanimation-iteration-count: 2;
animate-thriceanimation-iteration-count: 3;
animate-iteration-[10] *animation-iteration-count: 10;

Timing Function

ClassProperties
animate-easeanimation-timing-function: ease;
animate-ease-linearanimation-timing-function: linear;
animate-ease-inanimation-timing-function: cubic-bezier(0.4, 0, 1, 1);
animate-ease-outanimation-timing-function: cubic-bezier(0, 0, 0.2, 1);
animate-ease-in-outanimation-timing-function: cubic-bezier(0.4, 0, 0.2, 1);
animate-ease-[cubic-bezier(1,1,0,0)] *animation-timing-function: cubic-bezier(1, 1, 0, 0);

Fill Mode

ClassProperties
animate-fill-noneanimation-fill-mode: normal;
animate-fill-forwardsanimation-fill-mode: forwards;
animate-fill-backwardsanimation-fill-mode: backwards;
animate-fill-bothanimation-fill-mode: both;

Play State

ClassProperties
animate-runanimation-play-state: running;
animate-playanimation-play-state: running;
animate-stopanimation-play-state: paused;
animate-pauseanimation-play-state: paused;

Composition

ClassProperties
animate-replaceanimation-composition: replace;
animate-addanimation-composition: add;
animate-accumulateanimation-composition: accumulate;

Variant modifiers and breakpoints

All variants and breakpoints (hover, focus, lg, ...) work with animations und animation utility classes.

<div class="lg:hover:animate-shake motion-reduce:animate-none">
  <!-- ... -->
</div>

Arbitrary values

This plugin uses the Just-in-Time (JIT) engine, which allows you to use arbitrary values for most animation properties.

<div class="animate-delay-[85ms] animate-duration-[2s] animate-iteration-[10]">
  <!-- ... -->
</div>

Customizing your theme

If you want to change some animations, extend your tailwind.config.js file:

// tailwind.config.js
module.exports = {
  theme: {
    extend: {
      animationDelay: {
        275: '275ms',
        5000: '5s',
      },
      animationDuration: {
        2000: '2s',
        'long': '10s',
        'very-long': '20s',
      },
    },
  },
  plugins: [
    require('tailwindcss-animated')
  ],
}

Take a look at src/theme.js for the default settings.

FAQ

How to animate on scroll?

To run animations when an element enters the viewport, you need JavaScript. (At least until animation-timeline has good browser support)

A good starting point for a JavaScript solution would be the Intersection Observer API. Or tools that build on it, such as the Alpine.js Intersect plugin and the Tailwind CSS Intersection plugin, to name just two.

Does this work with the Play CDN?

Unfortunately not. The Tailwind CSS Play CDN currently does not support third-party plugins.

How to combine multiple animations?

The simplest approach is to nest two elements:

<div class="animate-pulse">
    <div class="animate-bounce"></div>
</div>

Can keyframes and offset values be changed?

Offset positions of predefined animations can't be changed on the fly. But the behavior can still be modified with animation-composition utilities.

If you need more details on how compositions work, check out the MDN Web Docs.


Keywords

FAQs

Package last updated on 20 Jun 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc