JSPM

tailwind-scroll-behavior

1.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1171
  • Score
    100M100P100Q107472F
  • License MIT

Tailwind plugin to create scroll behavior classes

Package Exports

  • tailwind-scroll-behavior

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (tailwind-scroll-behavior) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

TailwindCSS Scroll Behavior Plugin

npm

This plugin generates scroll-behavior classes.

A scroll-smooth and scroll-auto class will be created.

It is recommended that you use scroll-smooth in combination with Tailwind's motion-safe variant. This will only enable smooth scrolling for users who have not specified they prefer reduced motion.

Installation

Add to your project via:

# Install using npm
npm install -D tailwind-scroll-behavior

# Install using yarn
yarn add -D tailwind-scroll-behavior

Add it to the plugins array of your Tailwind config.

plugins: [
  require('tailwind-scroll-behavior')(), // no options to configure
]

By default, this plugin works with the motion-safe and motion-reduce variants. However, you can customise the variants for the plugin, by adding to the variants section of your Tailwind config.

variants: {
    scrollBehavior: ['motion-safe', 'motion-reduce', 'responsive']
}

License

This project is licensed under the MIT License.