原语 / Base UI
Sheet · Base UI
扩展自 Dialog 的侧边面板,用来展示与主内容互补的信息。
安装
Base UI 的原语保持上游 API 不变,安装只需要三步:加包、加组件、把 import 换掉。
bun add @animate-ui/react motion
bunx shadcn@latest add sheet
bunx @animate-ui/cli@latest animate sheet用法
从 Animate UI 引入原语,其余结构、属性与 data 属性都保持 Base UI 的写法。也可以按子路径单独引入:
import { Dialog as SheetPrimitive } from '@animate-ui/react/primitives/base-ui/dialog';import { Dialog as SheetPrimitive } from '@animate-ui/react/primitives/base-ui/dialog';
export function EditProfile() {
return (
<SheetPrimitive.Root>
<SheetPrimitive.Trigger>Open</SheetPrimitive.Trigger>
<SheetPrimitive.Portal>
<SheetPrimitive.Backdrop className="fixed inset-0" />
<SheetPrimitive.Popup
data-side="right"
className="fixed inset-y-0 right-0 w-3/4 sm:max-w-sm"
>
<SheetPrimitive.Title>Edit profile</SheetPrimitive.Title>
<SheetPrimitive.Description>
Make changes to your profile here.
</SheetPrimitive.Description>
<SheetPrimitive.Close>Close</SheetPrimitive.Close>
</SheetPrimitive.Popup>
</SheetPrimitive.Portal>
</SheetPrimitive.Root>
);
}动效
- 遮罩 400ms 渐入,背景与模糊同时增长,退场比面板更慢。
- 面板按 data-side 从对应边缘以自身尺寸滑入并淡入,0.4s 柔和 ease-out,全程减速、不过冲,避免边缘出现缝隙。
所有时长都会乘以 AnimateUIProvider 的 tempo,并遵守系统的减少动效设置。
API
动效相关的 transition 与 exitTransition 是 Animate UI 唯一新增的属性;其余 props 与 Base UI 完全一致。
| 属性 | 类型 | 默认值 |
|---|---|---|
| transition | Transition | { duration: 0.4, ease: [0.215, 0.61, 0.355, 1] } |
| exitTransition | Transition | transition |
| data-side | 'top' | 'right' | 'bottom' | 'left' | — |
| transition | Transition | { duration: 0.4, ease: [0.215, 0.61, 0.355, 1] } |
| exitTransition | Transition | { duration: 0.2, ease: [0.33, 0.17, 0.67, 0.5] } |
未列出的属性与上游 API 完全一致,可在 官方文档 查阅。
内容对应官方文档 2026-10-18 版本。