集成组合框 UI 组件

一个结合了输入框与可过滤选项列表的可搜索下拉组件，基于 Ariakit 构建，实现无障碍访问，采用先进的交互模式。

安装

你可以通过 Tiptap CLI 添加此基础组件

npx @tiptap/cli@latest add combobox

用法

import React from 'react'
import {
  ComboboxProvider,
  Combobox,
  ComboboxPopover,
  ComboboxList,
  ComboboxItem,
} from '@/components/tiptap-ui-primitive/combobox'

const ALL_OPTIONS = ['苹果', '香蕉', '樱桃', '枣']

export default function MyComponent() {
  const [value, setValue] = React.useState('')

  const matches = ALL_OPTIONS.filter((opt) =>
    opt.toLowerCase().startsWith(value.toLowerCase())
  )

  return (
    <ComboboxProvider value={value} setValue={setValue}>
      <Combobox placeholder="搜索选项..." />
      <ComboboxPopover>
        <ComboboxList>
          {matches.map((opt) => (
            <ComboboxItem key={opt} value={opt}>
              {opt}
            </ComboboxItem>
          ))}
        </ComboboxList>
      </ComboboxPopover>
    </ComboboxProvider>
  )
}

属性

ComboboxProvider

基于 Ariakit 的 ComboboxProvider，拥有优化的默认值。

名称	类型	默认	说明
includesBaseElement	`boolean`	false	是否将基础元素包含在 Tab 顺序中
resetValueOnHide	`boolean`	true	弹出层隐藏时是否重置值
value	`string`	-	当前选中的值
setValue	`(value: string) => void`	-	更新选中值的函数

Combobox

用于输入和过滤的输入框组件。

名称	类型	默认	说明
autoSelect	`boolean`	true	是否自动选中第一个选项

ComboboxItem

组合框列表中可单独选择的选项。

名称	类型	默认	说明
value	`string`	-	选择该项时设置的值

样式

组合框组件使用 CSS 自定义属性来支持主题定制：

.tiptap-combobox-list {
  --tt-combobox-bg-color: var(--white);
  --tt-combobox-border-color: var(--tt-gray-light-a-100);
  --tt-combobox-text-color: var(--tt-gray-light-a-600);

  .dark & {
    --tt-combobox-border-color: var(--tt-gray-dark-a-50);
    --tt-combobox-bg-color: var(--tt-gray-dark-50);
    --tt-combobox-text-color: var(--tt-gray-dark-a-600);
  }
}

Previously卡片

Next up下拉菜单