# @docsearch/sidepanel-js 中文文档

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

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

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

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

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

- 包体积（解压后）：6.6 MB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2025-12-22T16:45:18.361Z
- 最新版本发布：2026-10-29T13:15:30.546Z
- 近 30 天下载量：1452800（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：30（近 12 个月 30 个）

## 中文简介

用于 DocSearch Sidepanel 与 Ask AI 接口的 JavaScript 包 .

## 安装

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

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

## README

# @ docsearch/ sidepanel-js (英语)

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

## 安装

```bash
npm install @docsearch/sidepanel-js
```

## 开始吧

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

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

要开始,你需要一个 [`container`](https://docsearch.algolia.com/docs/api#container) 您的 DocSearch 侧面板组件进入 。 如果您还没有, 您可以在标记中插入一个 :

```html
<div id="docsearch-sidepanel"></div>
```

然后,将 DocSearch Sidepanel 插入到其中,叫它 [`sidepanel`](https://docsearch.algolia.com/docs/api) 函数并提供容器。 这可能是一个 [CSS 选择器](https://developer.mozilla.org/en-us/docs/web/css/css_selectors) 或一个 [元素](https://developer.mozilla.org/en-us/docs/web/api/htmlelement)。 。 。 .

确保提供 [`container`](https://docsearch.algolia.com/docs/api#container) (例如,a `div`) (中文(简体) ).

```js
import sidepanel from '@docsearch/sidepanel-js';

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

sidepanel({
  container: '#docsearch-sidepanel',
  indexName: 'YOUR_INDEX_NAME',
  appId: 'YOUR_APP_ID',
  apiKey: 'YOUR_SEARCH_API_KEY',
  agentId: 'YOUR_AGENT_ID',
});
```

## 文档

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

## 常见问题

### @docsearch/sidepanel-js 是什么？

用于 DocSearch Sidepanel 与 Ask AI 接口的 JavaScript 包 \.

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

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

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

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

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

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

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

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

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

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

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

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