跳到正文
目录与搜索
⌘K

原语 / Base UI

Context Menu · Base UI

在指针位置由右键或长按唤出的菜单。

安装

Base UI 的原语保持上游 API 不变,安装只需要三步:加包、加组件、把 import 换掉。

终端
bun add @animate-ui/react motion
bunx shadcn@latest add context-menu
bunx @animate-ui/cli@latest animate context-menu

用法

从 Animate UI 引入原语,其余结构、属性与 data 属性都保持 Base UI 的写法。也可以按子路径单独引入:

tsx
import { ContextMenu } from '@animate-ui/react/primitives/base-ui/context-menu';
context-menu.tsx
import { ContextMenu } from '@animate-ui/react/primitives/base-ui/context-menu';

export function CanvasMenu() {
  return (
    <ContextMenu.Root>
      <ContextMenu.Trigger>Right click here</ContextMenu.Trigger>
      <ContextMenu.Portal>
        <ContextMenu.Positioner>
          <ContextMenu.Popup>
            <ContextMenu.Item>Undo</ContextMenu.Item>
            <ContextMenu.Item>Duplicate</ContextMenu.Item>
            <ContextMenu.Separator />
            <ContextMenu.Item>Delete</ContextMenu.Item>
          </ContextMenu.Popup>
        </ContextMenu.Positioner>
      </ContextMenu.Portal>
    </ContextMenu.Root>
  );
}
context-menu.tsx
import { ContextMenu } from '@animate-ui/react/primitives/base-ui/context-menu';

export function CanvasMenu() {
  return (
    <ContextMenu.Root>
      <ContextMenu.Trigger>Right click here</ContextMenu.Trigger>
      <ContextMenu.Portal>
        <ContextMenu.Positioner>
          <ContextMenu.Popup>
            <ContextMenu.CheckboxItem defaultChecked>
              <ContextMenu.CheckboxItemIndicator animation="pop">
                <CheckIcon />
              </ContextMenu.CheckboxItemIndicator>
              Show grid
            </ContextMenu.CheckboxItem>
            <ContextMenu.Separator />
            <ContextMenu.RadioGroup defaultValue="fit">
              <ContextMenu.RadioItem value="fit">
                <ContextMenu.RadioItemIndicator animation="pop">
                  <CheckIcon />
                </ContextMenu.RadioItemIndicator>
                Zoom to fit
              </ContextMenu.RadioItem>
              <ContextMenu.RadioItem value="100">
                <ContextMenu.RadioItemIndicator animation="pop">
                  <CheckIcon />
                </ContextMenu.RadioItemIndicator>
                Zoom to 100%
              </ContextMenu.RadioItem>
            </ContextMenu.RadioGroup>
          </ContextMenu.Popup>
        </ContextMenu.Positioner>
      </ContextMenu.Portal>
    </ContextMenu.Root>
  );
}

动效

  • 弹层从指针位置以 0.9 缩放淡入,220ms 柔和 ease-out,关闭同路返回后卸载。
  • 子菜单从触发项的一侧以同样方式生长;展开方向由 Base UI 的定位结果决定。

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

API

动效相关的 transition 与 exitTransition 是 Animate UI 唯一新增的属性;其余 props 与 Base UI 完全一致。

属性类型默认值
transitionTransition{ duration: 0.22, ease: [0.215, 0.61, 0.355, 1] }
exitTransitionTransitiontransition
animation'draw' | 'pop'the closest AnimateUIProvider's checkAnimation, else 'draw'
transitionTransitiondraw: 0.3s on Motion's easeOut both ways (a Checkbox's, without its delay); pop: a spring (stiffness 500, damping 24) in, 0.15s out, and the highlight's spring (stiffness 500, damping 40) for the glide

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