原语 / Base UI
Toggle · Base UI
可开可关的两态按钮。
安装
Base UI 的原语保持上游 API 不变,安装只需要三步:加包、加组件、把 import 换掉。
bun add @animate-ui/react motion
bunx shadcn@latest add toggle
bunx @animate-ui/cli@latest animate toggle用法
从 Animate UI 引入原语,其余结构、属性与 data 属性都保持 Base UI 的写法。也可以按子路径单独引入:
import { Toggle } from '@animate-ui/react/primitives/base-ui/toggle';import { Toggle } from '@animate-ui/react/primitives/base-ui/toggle';
export function BoldToggle() {
return (
<Toggle aria-label="Toggle bold">
<BoldIcon />
</Toggle>
);
}动效
- 按下时缩放到 0.97,弹簧 stiffness 550 / damping 30,悬停不缩放。
- 缩放通过 transform 在合成层完成,shadcn/ui 的 transition-all 不会逐帧补间。
所有时长都会乘以 AnimateUIProvider 的 tempo,并遵守系统的减少动效设置。
API
动效相关的 transition 与 exitTransition 是 Animate UI 唯一新增的属性;其余 props 与 Base UI 完全一致。
| 属性 | 类型 | 默认值 |
|---|---|---|
| transition | Transition | { type: 'spring', stiffness: 550, damping: 30, restSpeed: 10 } |
未列出的属性与上游 API 完全一致,可在 官方文档 查阅。
内容对应官方文档 2026-10-18 版本。