JGuang

可搜索选择框

Combobox · Chakra UI

交互预览
npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0

可搜索选择框

输入文字用于检索,选中值代表结果,两种状态需要分开管理。异步搜索要区分加载、空结果和失败,远程选中值回填需加载对应项目;详见本组件的专属实用指南。

随附图标许可

源码查看器包含 ICON_ATTRIBUTION.md,以及本组示例实际使用的图标集合原始许可。再分发示例时请保留;react-icons 封装包的许可证不能替代各图标集合自身的条款。

  • Lucide: ISC

将文本输入与选项列表结合,适合搜索、单选和多选。输入文本与选中值是两种独立状态,不能把搜索词直接当作已经选中的业务值。此指南使用 Chakra UI 3.37.0 的原生 API。

初始化与基础结构

完成 setup.zh.md。基础示例从 @chakra-ui/react 导入 Combobox、Portal、useListCollection 和 useFilter。useListCollection 管理集合,useFilter 提供与 locale 相关的比较逻辑;需要远程搜索时由自己的数据源返回结果,不要同时套用不匹配的本地筛选规则。

保留 Combobox.Root、Combobox.Label、Combobox.Control、Combobox.Input,按需添加 Combobox.Trigger 和 Combobox.ClearTrigger。列表使用 Positioner、Content、Item 与 ItemIndicator;无结果使用 Combobox.Empty,错误不能伪装成无结果。

状态与原生示例

inputValue / onInputValueChange 管理输入文字,事件新值为 event.inputValue;value / onValueChange 管理选中值数组。受控状态由应用更新,不能只传 value 却忽略回调。

清单保留 28 个示例,包括多选、自定义对象、高亮、最少字符、禁用项、校验、表单、虚拟列表、受控展开、结果上限、创建选项与嵌套弹层。需要 store 时使用原生 useCombobox 与 Combobox.RootProvider,不要混用另一个库的 store。

异步搜索与值回填

combobox-with-async-content 和 combobox-rehydrate-value 额外使用 react-use@17.6.1,原始请求来自公开 Star Wars 接口。JGuang 预览阻止外部请求,保留原生错误状态,并提供中英文限制说明;不是可用的生产搜索服务。

回填示例先设置 defaultValue: ["C-3PO"],待集合有数据后调用 combobox.syncSelectedItems() 同步选中项。仅持有 ID 不保证能显示标签;生产环境需要可靠加载对应项,不能依赖当前搜索结果刚好包含它。

应用应检查 response.ok、取消或忽略旧请求、显示加载/错误/空状态,并根据实际需要进行防抖。不要向公开测试接口发送用户隐私。重置预览只重置状态,不解除 CSP。

验收与来源

检查输入、方向键、Enter 选择、Escape 关闭、清除、多选、无结果和错误恢复。虚拟列表需确认屏幕阅读器仍能关联活动选项;嵌套弹层参照 combobox-open-from-popover。深浅色沿用 Chakra Provider,业务文本由应用翻译。

此页是 JGuang 实用指南,原始文档与源码来自提交 2e7517745cff2fcde0b8012f136cf99611ff262a 并保存在 vendor。组件加载通过不等于所有搜索、网络和无障碍状态已验收。

安装与初始化

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0

渲染前配置 ChakraProvider、defaultSystem 和 Emotion。保留宿主项目的 React 版本并检查 peer 兼容。官方 npm 安装提供组件包,不会复制以下示例源码。locale、next-themes 和框架专属 SSR 配置见资源安装指南;npm 安装之外还需单独复制所选示例源码。

完整原生使用示例

这是固定版本的真实示例,不是通用 API 伪代码。复制完整源码依赖并保留命名导出;附加依赖逐例列在下方。

"use client"

import {
  Combobox,
  Portal,
  useFilter,
  useListCollection,
} from "@chakra-ui/react"

export const ComboboxBasic = () => {
  const { contains } = useFilter({ sensitivity: "base" })

  const { collection, filter } = useListCollection({
    initialItems: frameworks,
    filter: contains,
  })

  return (
    <Combobox.Root
      collection={collection}
      onInputValueChange={(e) => filter(e.inputValue)}
      width="320px"
    >
      <Combobox.Label>Select framework</Combobox.Label>
      <Combobox.Control>
        <Combobox.Input placeholder="Type to search" />
        <Combobox.IndicatorGroup>
          <Combobox.ClearTrigger />
          <Combobox.Trigger />
        </Combobox.IndicatorGroup>
      </Combobox.Control>
      <Portal>
        <Combobox.Positioner>
          <Combobox.Content>
            <Combobox.Empty>No items found</Combobox.Empty>
            {collection.items.map((item) => (
              <Combobox.Item item={item} key={item.value}>
                {item.label}
                <Combobox.ItemIndicator />
              </Combobox.Item>
            ))}
          </Combobox.Content>
        </Combobox.Positioner>
      </Portal>
    </Combobox.Root>
  )
}

const frameworks = [
  { label: "React", value: "react" },
  { label: "Solid", value: "solid" },
  { label: "Vue", value: "vue" },
  { label: "Angular", value: "angular" },
  { label: "Svelte", value: "svelte" },
  { label: "Preact", value: "preact" },
  { label: "Qwik", value: "qwik" },
  { label: "Lit", value: "lit" },
  { label: "Alpine.js", value: "alpinejs" },
  { label: "Ember", value: "ember" },
  { label: "Next.js", value: "nextjs" },
]

全部示例与复现要求

示例名称用于选择演示,不是组件通用 variant 属性。复制所选示例全部 sourceFiles;compositions 别名表示本地文件,不是 npm 包。保留相对导入或映射到宿主真实目录。React peer 单独检查;编辑器示例保留一致的固定 Tiptap 扩展版本。

基础用法

combobox-basic · 命名导出 ComboboxBasic · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/combobox-basic.tsx

不同尺寸

combobox-with-sizes · 命名导出 ComboboxWithSizes · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/combobox-with-sizes.tsx

不同变体

combobox-with-variants · 命名导出 ComboboxWithVariants · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/combobox-with-variants.tsx

多项选择

combobox-with-multiple · 命名导出 ComboboxWithMultiple · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/combobox-with-multiple.tsx

异步搜索内容

combobox-with-async-content · 命名导出 ComboboxWithAsyncContent · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 react-use@17.6.1
  • vendor/apps/compositions/src/examples/combobox-with-async-content.tsx

高亮

combobox-with-highlight · 命名导出 ComboboxWithHighlight · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/combobox-with-highlight.tsx

打开触发点击

combobox-open-on-click · 命名导出 ComboboxOpenOnClick · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/combobox-open-on-click.tsx

自定义对象

combobox-with-custom-object · 命名导出 ComboboxWithCustomObject · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/combobox-with-custom-object.tsx

最小字符

combobox-min-character · 命名导出 ComboboxMinCharacter · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/combobox-min-character.tsx

字段

combobox-with-field · 命名导出 ComboboxWithField · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/combobox-with-field.tsx

表单提交

combobox-with-form-submit · 命名导出 ComboboxWithFormSubmit · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/combobox-with-form-submit.tsx

React Hook Form 集成

combobox-with-hook-form · 命名导出 ComboboxWithHookForm · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 @hookform/resolvers@5.4.0 react-hook-form@7.77.0 zod@4.4.3
  • vendor/apps/compositions/src/examples/combobox-with-hook-form.tsx

禁用状态

combobox-with-disabled · 命名导出 ComboboxWithDisabled · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/combobox-with-disabled.tsx

禁用项目

combobox-with-disabled-item · 命名导出 ComboboxWithDisabledItem · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/combobox-with-disabled-item.tsx

输入分组

combobox-with-input-group · 命名导出 ComboboxWithInputGroup · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 react-icons@5.6.0
  • vendor/apps/compositions/src/examples/combobox-with-input-group.tsx

无效状态

combobox-with-invalid · 命名导出 ComboboxWithInvalid · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/combobox-with-invalid.tsx

受控状态

combobox-controlled · 命名导出 ComboboxControlled · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/combobox-controlled.tsx

外部状态仓库

combobox-with-store · 命名导出 ComboboxWithStore · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/combobox-with-store.tsx

打开受控

combobox-open-controlled · 命名导出 ComboboxOpenControlled · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/combobox-open-controlled.tsx

限制

combobox-with-limit · 命名导出 ComboboxWithLimit · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/combobox-with-limit.tsx

虚拟化

combobox-virtualized · 命名导出 ComboboxVirtualized · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 @tanstack/react-virtual@3.14.2
  • vendor/apps/compositions/src/examples/combobox-virtualized.tsx

链接

combobox-with-links · 命名导出 ComboboxWithLinks · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 react-icons@5.6.0
  • vendor/apps/compositions/src/examples/combobox-with-links.tsx

异步值回填

combobox-rehydrate-value · 命名导出 ComboboxRehydrateValue · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 react-use@17.6.1
  • vendor/apps/compositions/src/examples/combobox-rehydrate-value.tsx

自定义项目

combobox-with-custom-item · 命名导出 ComboboxWithCustomItem · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/combobox-with-custom-item.tsx

自定义筛选

combobox-with-custom-filter · 命名导出 ComboboxWithCustomFilter · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/combobox-with-custom-filter.tsx

自定义动画

combobox-with-custom-animation · 命名导出 ComboboxWithCustomAnimation · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/combobox-with-custom-animation.tsx

打开来源弹出层

combobox-open-from-popover · 命名导出 ComboboxOpenFromPopover · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/combobox-open-from-popover.tsx

可创建

combobox-with-createable · 命名导出 ComboboxWithCreateable · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/combobox-with-createable.tsx

原生 API 与源码参考

源码查看器保留原始声明、import 与继承关系。Ark UI 事件契约、Chakra 样式属性和 recipe 类型仍以原生包为准;本指南不平铺或编造默认值。代码注释保留原文,不冒充正文翻译。

  • npm/@chakra-ui/react@3.37.0/dist/types/components/combobox/combobox.d.ts
  • npm/@chakra-ui/react@3.37.0/dist/types/components/combobox/index.d.ts
  • npm/@chakra-ui/react@3.37.0/dist/types/components/combobox/namespace.d.ts

状态与安装后检查

执行严格类型检查、目标项目生产构建和实际操作。检查名称/焦点/键盘、深浅色、窄屏、原生支持的空/加载/错误状态以及卸载清理。预览限制远程接口、上传与下载,业务服务需自行配置。复制命令或预览就绪不代表安装完成或后端成功。

来源与许可边界

https://github.com/chakra-ui/chakra-ui/tree/2e7517745cff2fcde0b8012f136cf99611ff262a

本页是 JGuang 双语实用说明,不声称全文翻译上游 MDX。原始文档与示例字节保留在 vendor。保留仓库 MIT、compositions 的 ISC 元数据和独立依赖声明;原始许可元数据差异与缺失完整声明仍作为显式审查事项,不包含 Chakra Pro 付费内容。