跳到正文
目录与搜索
⌘K

原语 / Animate UI

Highlight · Animate UI

在条目之间滑动的背景块,可由点击、悬停或受控值驱动。

安装

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

终端
bun add @animate-ui/react motion

用法

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

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

export function Segmented() {
  return (
    <Highlight defaultValue="overview" className="rounded-full bg-accent">
      <button data-value="overview">Overview</button>
      <button data-value="activity">Activity</button>
      <button data-value="settings">Settings</button>
    </Highlight>
  );
}
highlight.tsx
<Highlight controlledItems hover className="rounded-md bg-accent">
  <nav>
    <HighlightItem value="docs">
      <a href="/docs">Docs</a>
    </HighlightItem>
    <HighlightItem value="blog">
      <a href="/blog">Blog</a>
    </HighlightItem>
  </nav>
</Highlight>

动效

  • children 模式下以 stiffness 500 / damping 40 的共享布局动画滑向新条目,同一帧完成交接,始终只有一块表面。
  • 没有高亮时淡入,失去高亮时在原位淡出;减少动效下位置直接跳变。

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

API

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

属性类型默认值
asReact.ElementType'div'
mode'children' | 'parent''children'
valuestring | null—
defaultValuestring | null—
onValueChange(value: string | null) => void—
classNamestring—
styleReact.CSSProperties—
transitionTransition{ type: 'spring', stiffness: 500, damping: 40 }
hoverbooleanfalse
clickbooleantrue
disabledbooleanfalse
enabledbooleantrue
exitDelaynumber200
controlledItemsboolean—
itemsClassNamestring—
boundsOffsetPartial<{ top: number; left: number; width: number; height: number }>—
containerClassNamestring—
forceUpdateBoundsboolean—
asReact.ElementType'div'
childrenReact.ReactElement—
idstring—
valuestring—
classNamestring—
activeClassNamestring—
styleReact.CSSProperties—
transitionTransition—
disabledboolean—
exitDelaynumber—
asChildbooleanfalse
forceUpdateBoundsboolean—

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

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