@docsearch/sidepanel-js

中文文档
5.2.0发布于 2026/10/29MITTypeScriptESM + CJS零依赖近 30 天下载 145.3万

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

中文使用文档
文档目录3 节
  1. 安装
  2. 开始吧
  3. 文档

@ docsearch/ sidepanel-js (英语)

JavaScript 软件包 DocSearch 侧面板,一个独立的 Ask AI 聊天面板.

安装

npm install @docsearch/sidepanel-js

开始吧

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

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

要开始,你需要一个 container 您的 DocSearch 侧面板组件进入 。 如果您还没有, 您可以在标记中插入一个 :

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

然后,将 DocSearch Sidepanel 插入到其中,叫它 sidepanel 函数并提供容器。 这可能是一个 CSS 选择器 或一个 元素。 。 。 .

确保提供 container (例如,a div) (中文(简体) ).

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',
});

文档

读取文档 +

版本与发布记录

@docsearch/sidepanel-js 共发布 30 个版本,首次发布于 2025/12/23;过去 12 个月发布了 30 个版本。

版本发布日期距今
5.2.0latest2026/10/2915 天前
5.1.22026/10/061 个月前
4.7.1latest-v42026/10/061 个月前
5.1.12026/09/191 个月前
5.1.02026/09/102 个月前
5.0.52026/09/042 个月前

其他发布通道:beta → 5.0.0-beta.4,latest-v4 → 4.7.1。

关于 @docsearch/sidepanel-js 的常见问题

@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 和提交记录判断。