跳到正文
目录与搜索
⌘K

原语 / Animate UI

Shine · Animate UI

扫过元素的一道光,可以只播一次、循环、悬停或点击触发。

安装

自有原语直接来自 @animate-ui/react,不依赖 Radix UI、Base UI 或 React Aria;装上包即可使用。

终端
bun add @animate-ui/react motion

用法

直接从 @animate-ui/react 的对应子路径引入,下面就是完整示例;样式由你的类名决定。

shine.tsx
import { Shine } from '@animate-ui/react/primitives/effects/shine';

export function GetStarted() {
  return (
    <Shine asChild loop loopDelay={500}>
      <button>Get started</button>
    </Shine>
  );
}

动效

  • 一道倾斜的光带在 duration(默认 1.2s,cubic-bezier(0.4, 0, 0.2, 1))内从左扫到右,并被元素裁剪。
  • 光带不接收指针事件,不会挡住交互;减少动效下不播放。

所有时长都会乘以 AnimateUIProvider 的 tempo,并遵守系统的减少动效设置。

API

动效相关的 transition 与 exitTransition 是 Animate UI 唯一新增的属性;其余 props 见上表。

属性类型默认值
asChildbooleanfalse
colorstring'currentColor'
opacitynumber0.3
durationnumber1200
delaynumber0
loopbooleanfalse
loopDelaynumber0
degnumber-15
enablebooleantrue
enableOnHoverbooleanfalse
enableOnTapbooleanfalse
…propsReact.ComponentProps<'div'>—

未列出的属性与上游 API 完全一致,可在 官方文档 查阅。

内容对应官方文档 2026-10-18 版本。