@chakra-ui/accordion

中文文档
2.3.1发布于 2023/09/09MITTypeScriptESM + CJS近 30 天下载 128.8万

React & Chakra UI 的简单易取的手风琴组件

中文使用文档
文档目录5 节
  1. 安装
  2. 导入组件
  3. 组件 :
  4. 使用量
  5. 参考文献:

@ chakra-ui/ accordion

手风琴是一个垂直堆放的交互式标题集,每个标题 包含一个标题或内容片段,代表部分内容.

标题作为控制功能,使用户能够披露或隐藏其 内容的相关章节.

安装

yarn add @chakra-ui/accordion

# or

npm i @chakra-ui/accordion

导入组件

import {
  Accordion,
  AccordionItem,
  AccordionButton,
  AccordionPanel,
} from "@chakra-ui/accordion"

组件 :

  • Accordion: 管理所有打开的手风琴物品的全球状况 上下文.
  • AccordionItem:管理单手风琴物品的状态.
  • AccordionButton:打开/关闭手风琴物品的触发器.
  • AccordionPanel:手风琴项目的主要内容区.

使用量

默认一次只可见一管风琴,不可能 切换.

说明:每个手风琴按钮必须用标题标签来包裹,即 适合页面信息架构.

<Accordion>
  <AccordionItem>
    <h2>
      <AccordionButton>Section 1 title</AccordionButton>
    </h2>
    <AccordionPanel>Panel 1</AccordionPanel>
  </AccordionItem>

  <AccordionItem>
    <h2>
      <AccordionButton>Section 2 title</AccordionButton>
    </h2>
    <AccordionPanel>Panel 2</AccordionPanel>
  </AccordionItem>
</Accordion>

要让每个手风琴切换( 扩展/ 缩放) 点击时, 通过 allowToggle 道具 (英语).

<Accordion allowToggle>
  <AccordionItem>
    <AccordionButton>
      <chakra.div flex="1" textAlign="left">
        Section 1 title
      </chakra.div>
      <AccordionIcon />
    </AccordionButton>
    <AccordionPanel pb={4}>Panel 1</AccordionPanel>
  </AccordionItem>

  <AccordionItem>
    <AccordionButton>
      <chakra.div flex="1" textAlign="left">
        Section 2 title
      </chakra.div>
      <AccordionIcon />
    </AccordionButton>
    <AccordionPanel pb={4}>Panel 2</AccordionPanel>
  </AccordionItem>
</Accordion>

为了让多个手风琴一次可见,通过 allowMultiple 道具 (英语).

<Accordion allowMultiple>
  <AccordionItem>
    <AccordionButton>
      <chakra.div flex="1" textAlign="left">
        Section 1 title
      </chakra.div>
      <AccordionIcon />
    </AccordionButton>
    <AccordionPanel pb={4}>Panel 1</AccordionPanel>
  </AccordionItem>

  <AccordionItem>
    <AccordionButton>
      <chakra.div flex="1" textAlign="left">
        Section 2 title
      </chakra.div>
      <AccordionIcon />
    </AccordionButton>
    <AccordionPanel pb={4}>Panel 2</AccordionPanel>
  </AccordionItem>
</Accordion>

参考文献:

https://www.w3.org/TR/wai-aria-practices/examples/accordion/accordion.html 页面存档备份,存于互联网档案馆 https://兼容并蓄-组件.design/collapsible-sections/ https://github.com/stereobooster/react-access-access-accordion 互联网档案馆的存檔,存档日期2013-12-21 https://jqueryui.com/accordion/ (中文(中国大陆) )

版本与发布记录

@chakra-ui/accordion 共发布 521 个版本,首次发布于 2020/06/21;过去 12 个月发布了 0 个版本。

版本发布日期距今
2.3.1latest2023/09/093 年前
0.0.0-dev-20230908144305dev2023/09/083 年前
0.0.0-dev-202308301338212023/08/303 年前
0.0.0-dev-202308301206422023/08/303 年前
0.0.0-dev-202308300937472023/08/303 年前
0.0.0-dev-202308221344342023/08/223 年前

其他发布通道:canary → 0.0.0-canary-2021118164051,pr → 0.0.0-pr-202212011232,next → 2.0.0-next.3,next-dev → 0.0.0-next-dev-202241614737,v1-latest → 1.4.12,dev → 0.0.0-dev-20230908144305。

关于 @chakra-ui/accordion 的常见问题

@chakra-ui/accordion 是什么?

React & Chakra UI 的简单易取的手风琴组件

如何安装 @chakra-ui/accordion?

在项目目录运行 npm install @chakra-ui/accordion,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(>=18)、framer-motion(>=4.0.0)、@chakra-ui/system(>=2.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@chakra-ui/accordion 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@chakra-ui/accordion 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@chakra-ui/accordion 可以商用吗?

@chakra-ui/accordion 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@chakra-ui/accordion 的下载量有多少?

根据 npm 官方下载统计,@chakra-ui/accordion 在 2026/10/10 – 2026/11/08 这 30 天内被下载 1,287,729 次,日均约 42,924 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@chakra-ui/accordion 还在维护吗?

最新版本 2.3.1 发布于 2023/09/09(3 年前);至今共发布 521 个版本,其中过去 12 个月发布了 0 个;首次发布于 2020/06/21。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。