跳到正文
目录与搜索
⌘K

原语 / React Aria

Combobox · React Aria

文本输入与列表框的组合,可按输入内容过滤选项。

安装

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

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

用法

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

tsx
import {
  ComboBox,
  Input,
  ListBox,
  ListBoxItem,
  Popover,
  SelectionIndicator,
} from '@animate-ui/react/primitives/react-aria';
combobox.tsx
import {
  ComboBox,
  Input,
  ListBox,
  ListBoxItem,
  Popover,
  SelectionIndicator,
} from '@animate-ui/react/primitives/react-aria';

const frameworks = [
  { id: 'next', name: 'Next.js' },
  { id: 'astro', name: 'Astro' },
  { id: 'sveltekit', name: 'SvelteKit' },
];

export function FrameworkPicker() {
  return (
    <ComboBox aria-label="Framework" defaultItems={frameworks}>
      <Input placeholder="Search a framework…" />
      <Popover placement="bottom start" offset={6}>
        <ListBox>
          {(item: (typeof frameworks)[number]) => (
            <ListBoxItem id={item.id} textValue={item.name}>
              {item.name}
              <SelectionIndicator>✓</SelectionIndicator>
            </ListBoxItem>
          )}
        </ListBox>
      </Popover>
    </ComboBox>
  );
}
combobox.tsx
<ListBoxItem id={item.id} textValue={item.name}>
  {item.name}
  <SelectionIndicator animation="pop">✓</SelectionIndicator>
</ListBoxItem>

动效

  • 选项列表在 Popover 中从输入框方向以 0.9 缩放淡入,220ms 柔和 ease-out,关闭同路返回。
  • 高亮块跟随指针与方向键滑动,始终只有一块;输入过滤时位置从当前状态接续。

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

API

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

属性类型默认值
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
transitionTransition{ type: 'spring', stiffness: 400, damping: 29 }
exitTransitionTransition{ duration: 0.15, ease: [0.23, 1, 0.32, 1] }

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