@benestudioco/react-scrollfade

中文文档
1.0.2发布于 2021/04/12MITCommonJS零依赖近 30 天下载 4147

A React component for fading out the bottom of a scrolling element.

原始使用文档
文档目录5 节
  1. Installation
  2. How to use it
  3. Browser Support
  4. Examples
  5. Contribution

React Scrollfade

React Scrollfade is a React component designed to dynamically fade out the bottom of a scrollable element based on the scrollbars position.

demo

Installation

You can install the library using npm:

npm install @benestudioco/react-scrollfade

How to use it

It works with zero configuration needed. Just include it as a direct child of the scrollable element. The fade makes the bottom of the element transparent, so the color of the fade is determined by what is under it.

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>

Browser Support

The component utilizes CSS masks and -webkit-masks as a fallbak. See browser compatibilities here: https://caniuse.com/?search=mask

Examples

There are interactive examples.

npm run examples starts an instance where you can look at them.

Contribution

We welcome contributions in the form of pull requests. The examples also serve as a development server.

If you have any issues, questions or suggestions please open a new Issue.

版本与发布记录

@benestudioco/react-scrollfade 共发布 6 个版本,首次发布于 2021/01/27;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.2latest2021/04/125 年前
1.0.12021/01/285 年前
1.0.02021/01/285 年前
1.0.0-alpha.42021/01/275 年前
1.0.0-alpha.32021/01/275 年前
1.0.0-alpha.12021/01/275 年前

关于 @benestudioco/react-scrollfade 的常见问题

@benestudioco/react-scrollfade 是什么?

A React component for fading out the bottom of a scrolling element.

如何安装 @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 和提交记录判断。