@codaworks/react-glow

中文文档
1.0.6发布于 2024/01/18MITTypeScriptESM + CJS零依赖近 30 天下载 3.2万

Add a mouse-tracing glow effect to React components

原始使用文档
文档目录5 节
  1. Installation
  2. Usage
  3. Tailwind
  4. Vanilla CSS
  5. Attribution

React glow

Add a mouse-tracing glow effect to React components.

gif of glow effect

The glow effect will only work using the mouse as the pointer. Touch events will not trigger it.

See it live on codaworks.com.

Installation

Install the package with npm:

npm i @codaworks/react-glow

Usage

Wrap any number of <Glow> components in a <GlowCapture> which will be used to track the mouse location.

<GlowCapture>
  <span>This won't glow</span>
  <Glow color='purple'>
    <span className='text-black glow:text-glow/50 glow:bg-red-100'>
      This will glow purple when the mouse is passed over
    </span>
  </Glow>
</GlowCapture>

Children of <Glow> can style themselves how to look when glowing. You might choose to leave some children unchanged, or highlight them with the glow: variant style.

The value of color will be available as a CSS variable --glow-color, as well as the Tailwind glow color. You can pass any valid CSS color, including hsl() values etc. Of course, you might choose to use any other color; you can leave out the color prop entirely.

Tailwind

Add the tailwind plugin to unlock the glow: variant and glow color

tailwind.config.js

module.exports = {
  ...
  plugins: [
    require('@codaworks/react-glow/tailwind')
  ]
}

As with all colors in Tailwind, you may add opacity by appending a percentage after the color, such as bg-glow/20 for 20% opacity.

Vanilla CSS

You can style the glow effect with vanilla CSS:

<GlowCapture>
  <span>This won't glow</span>
  <Glow color='hsl(338.69 100% 48.04%)'>
    <span className='glowable-text'>
      This will glow pink when the mouse is passed over
    </span>
  </Glow>
</GlowCapture>
.glowable-text {
  color: black;
}

[glow] .glowable-text {
  color: var(--glow-color);
}

Attribution

Inspired by this tweet.

版本与发布记录

@codaworks/react-glow 共发布 7 个版本,首次发布于 2023/09/28;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.6latest2024/01/182 年前
1.0.52023/12/282 年前
1.0.42023/12/072 年前
1.0.32023/09/293 年前
1.0.22023/09/283 年前
1.0.12023/09/283 年前

关于 @codaworks/react-glow 的常见问题

@codaworks/react-glow 是什么?

Add a mouse-tracing glow effect to React components

如何安装 @codaworks/react-glow?

在项目目录运行 npm install @codaworks/react-glow,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(>=16)、tailwindcss(>=3)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@codaworks/react-glow 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@codaworks/react-glow 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@codaworks/react-glow 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=10。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@codaworks/react-glow 可以商用吗?

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

@codaworks/react-glow 的下载量有多少?

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

@codaworks/react-glow 还在维护吗?

最新版本 1.0.6 发布于 2024/01/18(2 年前);至今共发布 7 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/09/28。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。