JGuang

选择列表

Listbox · Chakra UI

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

选择列表

在可见选项中进行单选、多选或扩展选择。明确选中值和活动焦点的区别,禁用项、分组和虚拟化不能破坏键盘定位;转移列表应保留项目身份。

随附图标许可

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

  • Lucide: ISC

安装与初始化

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 { Listbox, createListCollection } from "@chakra-ui/react"

export const ListboxBasic = () => {
  return (
    <Listbox.Root collection={frameworks} width="320px">
      <Listbox.Label>Select framework</Listbox.Label>
      <Listbox.Content>
        {frameworks.items.map((framework) => (
          <Listbox.Item item={framework} key={framework.value}>
            <Listbox.ItemText>{framework.label}</Listbox.ItemText>
            <Listbox.ItemIndicator />
          </Listbox.Item>
        ))}
      </Listbox.Content>
    </Listbox.Root>
  )
}

const frameworks = createListCollection({
  items: [
    { label: "React.js", value: "react" },
    { label: "Vue.js", value: "vue" },
    { label: "Angular", value: "angular" },
    { label: "Svelte", value: "svelte" },
  ],
})

全部示例与复现要求

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

基础用法

listbox-basic · 命名导出 ListboxBasic · 上游原始示例

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

受控状态

listbox-controlled · 命名导出 ListboxControlled · 上游原始示例

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

外部状态仓库

listbox-with-store · 命名导出 ListboxWithStore · 上游原始示例

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

禁用项目

listbox-disabled-item · 命名导出 ListboxDisabledItem · 上游原始示例

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

分组

listbox-grouped · 命名导出 ListboxGrouped · 上游原始示例

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

水平

listbox-horizontal · 命名导出 ListboxHorizontal · 上游原始示例

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

多选

listbox-multiselect · 命名导出 ListboxMultiselect · 上游原始示例

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

选择全部

listbox-select-all · 命名导出 ListboxSelectAll · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/listbox-select-all.tsx

扩展选择

listbox-extended-select · 命名导出 ListboxExtendedSelect · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/listbox-extended-select.tsx

勾选

listbox-with-checkmark · 命名导出 ListboxWithCheckmark · 上游原始示例

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

图标

listbox-with-icon · 命名导出 ListboxWithIcon · 上游原始示例

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

说明

listbox-with-description · 命名导出 ListboxWithDescription · 上游原始示例

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

输入

listbox-with-input · 命名导出 ListboxWithInput · 上游原始示例

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

弹出层

listbox-with-popover · 命名导出 ListboxWithPopover · 上游原始示例

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

对话框

listbox-with-dialog · 命名导出 ListboxWithDialog · 上游原始示例

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

虚拟化

listbox-virtualized · 命名导出 ListboxVirtualized · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 @tanstack/react-virtual@3.14.2 && npm install -D @types/node@22.19.19
  • vendor/apps/compositions/src/examples/listbox-virtualized.tsx

图片浏览器

listbox-image-explorer · 命名导出 ListboxImageExplorer · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/listbox-image-explorer.tsx

转移列表

listbox-transfer-list · 命名导出 ListboxTransferList · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 react-icons@5.6.0
  • vendor/apps/compositions/src/examples/listbox-transfer-list.tsx

表情网格

listbox-with-emoji-grid · 命名导出 ListboxWithEmojiGrid · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 emojibase-data@17.0.0 react-icons@5.6.0
  • vendor/apps/compositions/src/examples/listbox-with-emoji-grid.tsx

原生 API 与源码参考

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

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

状态与安装后检查

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

来源与许可边界

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

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