/tailwind-scroll-behavior

Tailwind v2 plugin to create classes for the scroll-behavior property

Primary LanguageJavaScriptMIT LicenseMIT

TailwindCSS Scroll Behavior Plugin

npm

This plugin generates scroll-behavior classes.

Note: As of TailwindCSS v3 these utilities are included by default.

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.