# @gleanwork/web-sdk 中文文档

规范地址：https://npmcn.com/package/%40gleanwork/web-sdk/

版本：2\.5\.0
npm 元数据更新时间：2026-09-30T18:34:01.709Z
中文译文更新时间：2026-11-16T15:38:37.092Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40gleanwork/web-sdk
原文对照：https://npmcn.com/package/%40gleanwork/web-sdk/?lang=original
项目主页：https://developers.glean.com/docs/browser_api/

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

- 包体积（解压后）：129 kB，8 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2024-05-02T20:56:13.019Z
- 最新版本发布：2026-09-30T18:34:01.397Z
- 近 30 天下载量：120078（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 3 个）

## 中文简介

嵌入 Glean UI 组件的库

## 安装

```sh
npm install @gleanwork/web-sdk
```

也可以使用：`pnpm add @gleanwork/web-sdk`、`yarn add @gleanwork/web-sdk`、`bun add @gleanwork/web-sdk`

## README

# 正在清除网络 SDK

Glean Web SDK 可以将AI的有动力搜索和聊天功能整合到您现有的内联网门户中. 该工具包提供不同的变体,以适应各种使用情况,并提供简化的搜索经验.

## 国家预防机制

我们建议使用 `@gleanwork/web-sdk` 在与Glean整合时,它也会提供适当的类型支持.

### 安装

以下列命令安装 Glean Web SDK :

```
// npm
npm install @gleanwork/web-sdk

// yarn
yarn add @gleanwork/web-sdk

// pnpm
pnpm add @gleanwork/web-sdk
```

### 使用量

```ts
// Can import all methods in one namespace GleanWebSDK
import GleanWebSDK, { type ModalSearchOptions } from "@gleanwork/web-sdk"

const optionalModalSearchOptions: ModalSearchOptions = {
  // ...
}
GleanWebSDK.attach(document.getElementById('search-box'), optionalModalSearchOptions)

// or can import individual methods instead
import { attach, type ModalSearchOptions } from "@gleanwork/web-sdk"
attach(document.getElementById('search-box'), optionalModalSearchOptions)
```

## 脚本标签

如果 npm 不是一个可行的解决方案, 您也可以通过脚本标记整合 Glean, just 将联署材料图书馆纳入 `<head>` 在您的页面中,请检查url=值 (帮助) 您所在的公司访问 Glean, 如 app. glean.com, {company}. glean.com.

```html
  <script
    src="https://{YOUR_GLEAN_DOMAIN}/sdk/glean-web-sdk-<version>.min.js"
  ></script>
```

这将提供国家防范机制一揽子方案通过下列途径提供的所有可用方法: `window.GleanWebSDK`, (中文(简体) ), 除此之外,使用将保持不变.

## 文档

使用详情可见于 [https://developers.glean.com/docs/browser api/ 页面存档备份,存于互联网档案馆](https://developers.glean.com/docs/browser_api/)

## 常见问题

### @gleanwork/web-sdk 是什么？

嵌入 Glean UI 组件的库

### 如何安装 @gleanwork/web-sdk？

在项目目录运行 npm install @gleanwork/web-sdk，或使用 pnpm add / yarn add / bun add。

### @gleanwork/web-sdk 支持 TypeScript 吗？

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

### @gleanwork/web-sdk 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @gleanwork/web-sdk 可以商用吗？

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

### @gleanwork/web-sdk 的下载量有多少？

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

### @gleanwork/web-sdk 还在维护吗？

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

