@ docsearch/ react (中文(简体) )
反应软件包 搜索文件最佳的搜索经验.
安装
npm install @docsearch/react@5
如果您不想使用软件包管理器, 您可以使用独立的端点 :
<script src="https://cdn.jsdelivr.net/npm/@docsearch/react@5"></script>
开始吧
DocSearch为您生成一个完全可访问的搜索框.
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;
文档
懒散地装入侧面板 静态 SidepanelButton 从 @docsearch/react/sidepanelButton 和动态面板导入 @docsearch/react/sidepanelPanel。 。 。 .
读取文档 +
关于 @docsearch/react 的常见问题
@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 和提交记录判断。