# @docsearch/sidepanel 中文文档

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

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

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

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

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

- 包体积（解压后）：24.8 kB，14 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：react \>= 16\.8\.0 \< 20\.0\.0，react-dom \>= 16\.8\.0 \< 20\.0\.0，@types/react \>= 16\.8\.0 \< 20\.0\.0
- 首次发布：2025-12-22T16:45:15.453Z
- 最新版本发布：2026-10-29T13:16:21.443Z
- 近 30 天下载量：6801（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：30（近 12 个月 30 个）

## 中文简介

DocSearch Sidepanel 包,用于询问AI.

## 安装

```sh
npm install @docsearch/sidepanel
```

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

## README

# @ docsearch/ sidepage

反应软件包 [DocSearch 侧面板](http://docsearch.algolia.com/),一个独立的 Ask AI 聊天面板.

## 安装

```bash
# or
npm install @docsearch/core@5 @docsearch/sidepanel@5 @docsearch/css@5
```

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

```html
<script src="https://cdn.jsdelivr.net/npm/@docsearch/sidepanel-js"></script>
```

## 开始吧

DocSearch Sidepanel 为您生成一个完全可访问的 Ask AI 聊天面板 .

```jsx
import { DocSearch } from '@docsearch/core';
import { SidepanelButton, Sidepanel } from '@docsearch/sidepanel';

// Or using individual imports:
// import { Sidepanel } from '@docsearch/sidepanel/sidepanel';
// import { SidepanelButton } from '@docsearch/sidepanel/button';

import '@docsearch/css/dist/style.css';
import '@docsearch/css/dist/sidepanel.css';

function App() {
  return (
    <DocSearch>
      <SidepanelButton />
      <Sidepanel
        appId="YOUR_APP_ID"
        apiKey="YOUR_SEARCH_API_KEY"
        agentId="YOUR_AGENT_ID"
      />
    </DocSearch>
  );
}
```

## 文档

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

## 常见问题

### @docsearch/sidepanel 是什么？

DocSearch Sidepanel 包,用于询问AI\.

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

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

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

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

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

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

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

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

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

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

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

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