跳到正文
目录与搜索
⌘K

原语 / Base UI

Combobox · Base UI

输入框与预定义选项列表的组合,支持过滤与键盘导航。

安装

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

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

用法

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

tsx
import { Combobox } from '@animate-ui/react/primitives/base-ui/combobox';
combobox.tsx
import { Combobox } from '@animate-ui/react/primitives/base-ui/combobox';

const frameworks = ['Next.js', 'React Router', 'Astro', 'SvelteKit'];

export function FrameworkPicker() {
  return (
    <Combobox.Root items={frameworks}>
      <Combobox.Input
        aria-label="Framework"
        placeholder="Search a framework…"
      />
      <Combobox.Portal>
        <Combobox.Positioner sideOffset={6}>
          <Combobox.Popup>
            <Combobox.Empty>No framework found.</Combobox.Empty>
            <Combobox.List>
              {(item: string) => (
                <Combobox.Item key={item} value={item}>
                  {item}
                </Combobox.Item>
              )}
            </Combobox.List>
          </Combobox.Popup>
        </Combobox.Positioner>
      </Combobox.Portal>
    </Combobox.Root>
  );
}
combobox.tsx
<Combobox.Item key={item} value={item}>
  {item}
  <Combobox.ItemIndicator animation="pop">✓</Combobox.ItemIndicator>
</Combobox.Item>

动效

  • 弹层从输入框方向以 0.9 缩放淡入,220ms 柔和 ease-out,关闭同样反向播放后卸载。
  • 高亮块以 stiffness 500 / damping 40 的弹簧在选项间滑动,跟随指针与方向键,始终只有一块;离开列表时停在最后一项。

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

API

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

属性类型默认值
transitionTransition{ duration: 0.22, ease: [0.215, 0.61, 0.355, 1] }
exitTransitionTransitiontransition
transitionTransition{ type: 'spring', stiffness: 400, damping: 29 }
exitTransitionTransition{ duration: 0.15, ease: [0.23, 1, 0.32, 1] }
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 完全一致,可在 官方文档 查阅。