# @docsearch/react 中文文档

规范地址：https://npmcn.com/package/%40docsearch/react/

版本：5\.2\.0
npm 元数据更新时间：2026-10-29T13:15:31.872Z
中文译文更新时间：2026-11-12T14:01:14.066Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40docsearch/react
原文对照：https://npmcn.com/package/%40docsearch/react/?lang=original
项目主页：https://docsearch.algolia.com/
源码仓库：https://github.com/algolia/docsearch

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

- 包体积（解压后）：4.3 MB，78 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：9 个
- peer 依赖：react \>= 16\.8\.0 \< 20\.0\.0，react-dom \>= 16\.8\.0 \< 20\.0\.0，@types/react \>= 16\.8\.0 \< 20\.0\.0，search-insights \>= 1 \< 3
- 首次发布：2020-05-15T14:23:46.177Z
- 最新版本发布：2026-10-29T13:15:31.304Z
- 近 30 天下载量：12822871（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：102（近 12 个月 30 个）

## 中文简介

DocSearch的回放软件包,Docs的最佳搜索体验.

## 安装

```sh
npm install @docsearch/react
```

也可以使用：`pnpm add @docsearch/react`、`yarn add @docsearch/react`、`bun add @docsearch/react`

## README

# @ docsearch/ react (中文(简体) )

反应软件包 [搜索文件](http://docsearch.algolia.com/)最佳的搜索经验.

## 安装

```bash
npm install @docsearch/react@5
```

如果您不想使用软件包管理器, 您可以使用独立的端点 :

```html
<script src="https://cdn.jsdelivr.net/npm/@docsearch/react@5"></script>
```

## 开始吧

DocSearch为您生成一个完全可访问的搜索框.

```jsx
import { DocSearch } from '@docsearch/react';

import '@docsearch/css';

function App() {
  return (
    <DocSearch
      appId="YOUR_APP_ID"
      indices={['YOUR_INDEX_NAME']}
      apiKey="YOUR_SEARCH_API_KEY"
    />
  );
}

export default App;
```

## 文档

[懒散地装入侧面板](https://docsearch.algolia.com/docs/packages/react/examples#lazy-load-the-sidepanel) 静态 `SidepanelButton` 从 `@docsearch/react/sidepanelButton` 和动态面板导入 `@docsearch/react/sidepanelPanel`。 。 。 .

[读取文档 +](https://docsearch.algolia.com/docs/packages/react/getting-started)

## 常见问题

### @docsearch/react 是什么？

DocSearch的回放软件包,Docs的最佳搜索体验\.

### 如何安装 @docsearch/react？

在项目目录运行 npm install @docsearch/react，或使用 pnpm add / yarn add / bun add。

### @docsearch/react 支持 TypeScript 吗？

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

### @docsearch/react 支持 ESM 还是 CommonJS？

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

### @docsearch/react 可以商用吗？

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

### @docsearch/react 的下载量有多少？

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

### @docsearch/react 还在维护吗？

最新版本 5\.2\.0 发布于 2026/10/29（15 天前）；至今共发布 102 个版本，其中过去 12 个月发布了 30 个；首次发布于 2020/05/15。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。