JSPM

tailwind-scrollbar-utilities

0.3.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2615
  • Score
    100M100P100Q127693F
  • License MIT

Tailwind plugin for scrollbar class utilities

Package Exports

  • tailwind-scrollbar-utilities
  • tailwind-scrollbar-utilities/index
  • tailwind-scrollbar-utilities/index.css
  • tailwind-scrollbar-utilities/package.json

Readme

TailwindCSS Scrollbar Utilities Plugin

npm

This plugin generates utility classes for scrollbar-gutter, scrollbar-width, and scrollbar-color.

Installation

Add to your project via:

# Install using npm
npm install -D tailwind-scrollbar-utilities

# Install using yarn
yarn add -D tailwind-scrollbar-utilities

When using CSS config

Add an import for the plugin in your CSS file. You cannot currently import only specific groups of utilities.

@import "tailwind-scrollbar-utilities";

Usage

scrollbar-gutter

  • scrollbar-gutter-auto: Adds scrollbar-gutter: auto; to the element.

  • scrollbar-gutter-stable: Adds scrollbar-gutter: stable; to the element.

  • scrollbar-gutter-stable along with scrollbar-gutter-both-edges: Adds scrollbar-gutter: stable both-edges; to the element.

scrollbar-width

  • scrollbar-width-auto: Adds scrollbar-width: auto; to the element.

  • scrollbar-thin: Adds scrollbar-width: thin; to the element.

  • scrollbar-none: Adds scrollbar-width: none; to the element. It also adds a ::-webkit-scrollbar fallback for better browser support.

scrollbar-color

  • scrollbar-color-auto: Adds scrollbar-color: auto; to the element.

  • scrollbar-thumb-{color}: Sets the thumb color portion of the scrollbar color property.

  • scrollbar-track-{color}: Sets the track color portion of the scrollbar color property.

  • scrollbar-color: Adds scrollbar-color: {thumb-color} {track-color}; to the element. It's important to note you must set both color values for this to have any effect.

Where {color} is any available tailwind color e.g. scrollbar-thumb-teal-900

You can also use arbitrary values such as scrollbar-track-[Canvas].

License

This project is licensed under the MIT License.