# @benestudioco/react-scrollfade 中文文档

规范地址：https://npmcn.com/package/%40benestudioco/react-scrollfade/

版本：1\.0\.2
npm 元数据更新时间：2023-09-27T18:00:48.233Z
中文译文更新时间：2026-11-07T22:11:36.059Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：8.3 kB，8 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- peer 依赖：prop-types ^15\.6\.0，react ^16\.0\.0，react-dom ^16\.0\.0
- 首次发布：2021-01-27T10:53:37.761Z
- 最新版本发布：2021-04-12T09:26:54.343Z
- 近 30 天下载量：4147（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 0 个）

## 中文简介

向滚动元素底部淡出的反应组件.

## 安装

```sh
npm install @benestudioco/react-scrollfade
```

也可以使用：`pnpm add @benestudioco/react-scrollfade`、`yarn add @benestudioco/react-scrollfade`、`bun add @benestudioco/react-scrollfade`

## README

# 反应卷轴

React Scrollfade是一个 React 组件,旨在以滚动条位置为基础,动态地淡出可滚动元素的下部.

![demo](https://npmcn.com/package/%40benestudioco/react-scrollfade/scroll_fade_example.png)

## 安装

您可以使用 npm 安装库 :

```
npm install @benestudioco/react-scrollfade
```

## 怎样用

它的工作需要零配置。 只要把它作为可滚动元素的直系子. 淡出使元素底部透明,因此淡出颜色由它下面的东西决定.

```jsx
import React from "react";
import ScrollFade from "@benestudioco/react-scrollfade";

export const Example = () =>
 <div
        style={{
            width: 200,
            height: 100,
            overflowY: 'auto',
            background: 'red',
        }}
    >
        <ScrollFade />
        Dolor amet eu occaecat excepteur do adipisicing cillum duis. Est ullamco ullamco sit ea irure consequat
        id do ex enim consectetur nisi duis elit. Qui mollit magna exercitation est sit.
    </div>
```

### 浏览器支持

该部分使用CSS口罩和-webkit-masks作为倒扣. 此处参见浏览器兼容性 : [https://caniuse.com/?search=mask (中文(中国大陆) )](https://caniuse.com/?search=mask)

### 实例

有互动的例子.

`npm run examples` 开始一个可以查看它们的例子.

## 捐款

我们欢迎以拉动请求形式提供的捐助. 这些例子也充当了开发服务器.

如有任何问题、问题或建议,请重新印发.

## 常见问题

### @benestudioco/react-scrollfade 是什么？

向滚动元素底部淡出的反应组件\.

### 如何安装 @benestudioco/react-scrollfade？

在项目目录运行 npm install @benestudioco/react-scrollfade，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：prop-types（^15\.6\.0）、react（^16\.0\.0）、react-dom（^16\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @benestudioco/react-scrollfade 支持 TypeScript 吗？

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

### @benestudioco/react-scrollfade 支持 ESM 还是 CommonJS？

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

### @benestudioco/react-scrollfade 可以商用吗？

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

### @benestudioco/react-scrollfade 的下载量有多少？

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

### @benestudioco/react-scrollfade 还在维护吗？

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