# @chakra-ui/descendant 中文文档

规范地址：https://npmcn.com/package/%40chakra-ui/descendant/

版本：3\.1\.0
npm 元数据更新时间：2025-08-25T12:24:35.536Z
中文译文更新时间：2026-11-09T09:49:48.398Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40chakra-ui/descendant
原文对照：https://npmcn.com/package/%40chakra-ui/descendant/?lang=original
项目主页：https://github.com/chakra-ui/chakra-ui#readme
源码仓库：https://github.com/chakra-ui/chakra-ui

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：99.5 kB，29 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：react \>=18
- 首次发布：2020-06-20T20:43:06.229Z
- 最新版本发布：2023-07-18T23:00:44.195Z
- 近 30 天下载量：1427924（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：175（近 12 个月 0 个）

## 中文简介

登记反应要素的儿童节点,以更好地获取

## 安装

```sh
npm install @chakra-ui/descendant
```

也可以使用：`pnpm add @chakra-ui/descendant`、`yarn add @chakra-ui/descendant`、`bun add @chakra-ui/descendant`

## README

# 后裔

跟踪后人成分及其相对指数.

改善大院无障碍支持的后裔指数解决方案 组件.

> **注释 :** 此套件主要供查克拉人内部使用 UI图书馆. 生产经营项目不得直接使用.

## 安装

```sh
yarn add @chakra-ui/descendant

# or

npm i @chakra-ui/descendant
```

## 动机

子孙观察者是追踪后人元素的有用钩子 及其相对指数.

简言之,这个包允许列表中的每个项目了解其相对索引和 名单的家长可以追踪每个孩子,而不需要提供 在一个循环中,通过每个组件的索引.

这使得组件组成:

```jsx
<List>
  <Item /> // I'm index 0
  <Item /> // I'm index 1<div>
    <div>
      <Item /> // I'm arbitrarily nested, but still know that I'm index 2
    </div>
  </div>
</List>
```

### 使用量

```jsx
import { createDescendantContext } from "@chakra-ui/descendant"
import * as React from "react"

const [
  DescendantsProvider,
  useDescendantsContext,
  useDescendants,
  useDescendant,
] = createDescendantContext()

const MenuContext = React.createContext({})

function Menu({ children }) {
  // 1. Call the `useDescendants` hook
  const descendants = useDescendants()

  const [selected, setSelected] = React.useState(1)
  const context = React.useMemo(() => ({ selected, setSelected }), [selected])

  return (
    // 2. Add the descendants context
    <DescendantsProvider value={descendants}>
      <MenuContext.Provider value={context}>
        <div role="menu" style={{ maxWidth: 320 }}>
          <button
            onClick={() => {
              const prev = descendants.prev(selected)
              prev.node.focus()
              setSelected(prev.index)
            }}
          >
            Prev
          </button>
          <button
            onClick={() => {
              const next = descendants.next(selected)
              next.node.focus()
              setSelected(next.index)
            }}
          >
            Next
          </button>
          {children}
        </div>
      </MenuContext.Provider>
    </DescendantsProvider>
  )
}

const MenuItem = ({ children }) => {
  const { selected, setSelected } = React.useContext(MenuContext)

  // 3. Read from descendant context
  const { index, register } = useDescendant()

  const isSelected = index === selected

  return (
    <div
      role="menuitem"
      ref={register}
      aria-selected={isSelected}
      onMouseMove={() => setSelected(index)}
      style={{ color: isSelected ? "red" : "black" }}
    >
      {children} - {index}
    </div>
  )
}

const Example = () => {
  const [show, setShow] = React.useState(false)
  const [show2, setShow2] = React.useState(false)

  const toggle = () => {
    setShow(!show)
    if (!show === true) {
      setTimeout(() => {
        setShow2(true)
      }, 1000)
    }
  }

  return (
    <div>
      <button onClick={toggle}>Toggle</button>
      <Menu>
        <MenuItem>One</MenuItem>
        {show && <MenuItem>Two</MenuItem>}
        <MenuItem>Three</MenuItem>
        <MenuItem>Four</MenuItem>
        <div>
          {show2 && <MenuItem>Testing 🌟</MenuItem>}
          <MenuItem>Five</MenuItem>
        </div>
      </Menu>
    </div>
  )
}
```

## 常见问题

### @chakra-ui/descendant 是什么？

登记反应要素的儿童节点,以更好地获取

### 如何安装 @chakra-ui/descendant？

在项目目录运行 npm install @chakra-ui/descendant，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=18）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @chakra-ui/descendant 支持 TypeScript 吗？

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

### @chakra-ui/descendant 支持 ESM 还是 CommonJS？

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

### @chakra-ui/descendant 可以商用吗？

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

### @chakra-ui/descendant 的下载量有多少？

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

### @chakra-ui/descendant 还在维护吗？

最新版本 3\.1\.0 发布于 2023/07/19（3 年前）；至今共发布 175 个版本，其中过去 12 个月发布了 0 个；首次发布于 2020/06/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。