# @gradin/tailwindcss-scrollbar 中文文档

规范地址：https://npmcn.com/package/%40gradin/tailwindcss-scrollbar/

版本：3\.0\.1
npm 元数据更新时间：2022-11-17T12:58:43.828Z
中文译文更新时间：2026-11-16T21:34:14.389Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40gradin/tailwindcss-scrollbar
原文对照：https://npmcn.com/package/%40gradin/tailwindcss-scrollbar/?lang=original
项目主页：https://github.com/gradints/tailwindcss-scrollbar#readme
源码仓库：https://github.com/gradints/tailwindcss-scrollbar

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：13.4 kB，4 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- peer 依赖：tailwindcss \>=2\.0\.0
- 首次发布：2021-04-10T13:50:41.457Z
- 最新版本发布：2022-11-17T12:58:43.754Z
- 近 30 天下载量：42355（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：20（近 12 个月 0 个）

## 中文简介

用于自定义滚动条的 Tailwindcs 插件 .

## 安装

```sh
npm install @gradin/tailwindcss-scrollbar
```

也可以使用：`pnpm add @gradin/tailwindcss-scrollbar`、`yarn add @gradin/tailwindcss-scrollbar`、`bun add @gradin/tailwindcss-scrollbar`

## README

# 尾风- 滚动栏

用于自定义浏览器滚动条的 Tailwindcs 插件 .

[![npm (scoped)](https://img.shields.io/npm/v/@gradin/tailwindcss-scrollbar)](https://www.npmjs.com/package/@gradin/tailwindcss-scrollbar) ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/min/@gradin/tailwindcss-scrollbar) ![npm](https://img.shields.io/npm/dt/@gradin/tailwindcss-scrollbar)

[现场直播](https://play.tailwindcss.com/ITNFDL0Skg)

## 安装

```sh
# Using npm
npm install -D @gradin/tailwindcss-scrollbar

# Using Yarn
yarn add -D @gradin/tailwindcss-scrollbar
```

然后将插件添加到 `tailwind.config.js` 文档.

```js
module.exports = {
  theme: {
    // ...
  },
  plugins: [
    require('@gradin/tailwindcss-scrollbar'),
  ],
}
```

## 配置

您可以自定义滚动条的大小和颜色 。 还支持任何 Css 属性,例如 `borderRadius`。 。 。 .

见 [发布注释](https://github.com/gradints/tailwindcss-scrollbar/releases/tag/2.0.2) 如果您正在从 v1 qq 升级

```js
module.exports = {
  theme: {
    // ...
  },
  plugins: [
    require('@gradin/tailwindcss-scrollbar')({
      size: '5px', // width or height, default '5px'
      track: {
        background: 'lightgray', // default '#f1f1f1'
        // add other css attributes here,
        // will be merged to ::-webkit-scrollbar-track
      },
      thumb: {
        background: 'gray', // default '#c1c1c1'
        borderRadius: '40px',
        // add other css attributes here,
        // will be merged to ::-webkit-scrollbar-thumb
      },
      hover: {
        background: 'darkgray', // default '#a8a8a8'
        borderRadius: '40px',
        // add other css attributes here,
        // will be merged to ::-webkit-scrollbar-thumb:hover
      },
    }),
  ],
}
```

要使用您配置中的属性 。 主题,您需要覆盖 `theme.scrollbar.DEFAULT`。 。 。 .

```js
module.exports = {
  theme: {
    // ...
    scrollbar: theme => ({
      DEFAULT: {
        size: theme('spacing.1'),
        track: {
          background: theme('colors.gray.300'),
        },
        thumb: {
          background: theme('colors.gray.400'),
        },
        hover: {
          background: theme('colors.gray.500'),
        },
      },
    })
  },
  plugins: [
    require('@gradin/tailwindcss-scrollbar'),
  ],
}
```

## 多个滚动条样式

您可以使用 `theme.scrollbar.STYLE_NAME`

他们需要 `size`, (中文(简体) ), `track`, (中文(简体) ), `thumb`, (中文(简体) ), `hover` 指定属性,因为它们没有默认值.

```js
module.exports = {
  theme: {
    // ...
    scrollbar: {
      thin: {
        size: '2px',
        track: { background: 'lightgray' },
        thumb: { background: 'gray' },
        hover: { background: 'darkgray' },
      },
      blue: {
        size: '8px',
        track: { background: 'lightblue' },
        thumb: { background: 'blue' },
        hover: { background: 'darkblue' },
      },
    },
  },
}
```

```html
<div class="overflow-auto scrollbar-thin"></div>
<div class="overflow-auto scrollbar-blue"></div>
```

## 黑暗模式

要在暗模式下设置不同的背景颜色, 您可以使用 `darkBackground` 属性。 如果未设定, 它们的颜色与 `background`。 。 。 .

```js
track: {
  background: theme('colors.gray.300'),
  darkBackground: theme('colors.gray.800'),
},
thumb: {
  background: theme('colors.gray.400'),
  darkBackground: theme('colors.gray.600'),
},
hover: {
  background: theme('colors.gray.500'),
  darkBackground: theme('colors.gray.500'),
},
```

## 隐藏滚动条.

隐藏滚动条,但仍使其可以滚动,使用 `scrollbar-none` 类 元素的 `overflow: auto | scroll`。 。 。 .

```html
<div class="overflow-auto scrollbar-none">
  <!-- Very long content here -->
</div>
```

这是通过使用 `scrollbar-width: none` 灭火器和 `::-webkit-scrollbar{display:none}` 在克罗姆岛.

## 浏览器支持

此插件使用 `::-webkit-scrollbar` 以修改滚动条样式.

不支持在 **firefox 的所有版本** 财务报告和审定财务报表 **边缘版本 78 或以上**。 。 。 .

[参见浏览器兼容性](https://caniuse.com/?search=%3A%3A-webkit-scrollbar)

`.scrollbar-none` 支持在 [Firefox 64 版本或更新版本](https://caniuse.com/?search=scrollbar-width)。 。 。 .

## 常见问题

### @gradin/tailwindcss-scrollbar 是什么？

用于自定义滚动条的 Tailwindcs 插件 \.

### 如何安装 @gradin/tailwindcss-scrollbar？

在项目目录运行 npm install @gradin/tailwindcss-scrollbar，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：tailwindcss（\>=2\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @gradin/tailwindcss-scrollbar 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/gradin\_\_tailwindcss-scrollbar 是否存在。

### @gradin/tailwindcss-scrollbar 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @gradin/tailwindcss-scrollbar 可以商用吗？

@gradin/tailwindcss-scrollbar 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @gradin/tailwindcss-scrollbar 的下载量有多少？

根据 npm 官方下载统计，@gradin/tailwindcss-scrollbar 在 2026/10/17 – 2026/11/15 这 30 天内被下载 42,355 次，日均约 1,412 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @gradin/tailwindcss-scrollbar 还在维护吗？

最新版本 3\.0\.1 发布于 2022/11/17（3 年前）；至今共发布 20 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/04/10。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

