# @blackbaud/help-client 中文文档

规范地址：https://npmcn.com/package/%40blackbaud/help-client/

版本：3\.1\.1
npm 元数据更新时间：2022-06-12T15:20:31.523Z
中文译文更新时间：2026-11-08T05:47:39.764Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40blackbaud/help-client
原文对照：https://npmcn.com/package/%40blackbaud/help-client/?lang=original
项目主页：https://github.com/blackbaud/help-client#readme
源码仓库：https://github.com/blackbaud/help-client

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

- 包体积（解压后）：153 kB，104 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2017-05-02T19:37:36.229Z
- 最新版本发布：2022-05-03T16:00:44.066Z
- 近 30 天下载量：2015（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：50（近 12 个月 0 个）

## 中文简介

提供客户端库,用于与“帮助部件”互动.

## 安装

```sh
npm install @blackbaud/help-client
```

也可以使用：`pnpm add @blackbaud/help-client`、`yarn add @blackbaud/help-client`、`bun add @blackbaud/help-client`

## README

# @ blackbaud/ 帮助客户端

[![npm](https://img.shields.io/npm/v/@blackbaud/help-client.svg)](https://www.npmjs.com/package/@blackbaud/help-client) [![status](https://dev.azure.com/blackbaud/Products/_apis/build/status/help-client?branchName=master)](https://dev.azure.com/blackbaud/Products/_build/latest?definitionId=5831&branchName=master)

提供客户端库,用于与“帮助部件”互动。 此模块属于 [@ sskyux-sdk/ 建设者](https://github.com/blackbaud/skyux-sdk-builder) 财务报告和审定财务报表 [@blackbaud/skyux-lib-帮助](https://github.com/blackbaud/skyux-lib-help)。 。 。 .

## SKYUX 用户

```json
{
  "help": {
    "helpMode": "menu"
  }
}
```

```typescript
// inside a consumer's typescript code
BBHELP.HelpWidget.open('foo.html');
```

见 [帮助配置( t)](https://npmcn.com/package/%40blackbaud/help-client/src/help-config.ts) 用于更多的配置属性.

## 菜单模式

何时 `helpMode` 实值 `menu`,期望是 `@blackbaud-internal/skyux-spa-omnibar` 将控制无所不在的触发器,而不是 `help-client`因此, `help-client` 将 _没有_ 显示任何触发部件的可视元素。 奥姆尼巴将在菜单设计中构建出视觉元素取而代之. 任何用途 `BBHELP.HelpWidget#open` 将会导致在新标签中打开这个话题.

> `menu` 为任何消费者推荐的模式.

## 遗留模式

何时 `helpMode` 实值 `legacy`, (中文(简体) ), `help-client` 在 DOM 中添加一个触发器,用于模仿 `@blackbaud-internal/skyux-spa-omnibar` 并设置一个无所不在的触发器 _顶端_ 在全纳巴。 所有用途 `BBHELP.HelpWidget` 将扩展此触发器, 在帮助部件中显示想要的话题 .

## 常见问题

### @blackbaud/help-client 是什么？

提供客户端库,用于与“帮助部件”互动\.

### 如何安装 @blackbaud/help-client？

在项目目录运行 npm install @blackbaud/help-client，或使用 pnpm add / yarn add / bun add。

### @blackbaud/help-client 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/blackbaud\_\_help-client 是否存在。

### @blackbaud/help-client 支持 ESM 还是 CommonJS？

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

### @blackbaud/help-client 可以商用吗？

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

### @blackbaud/help-client 的下载量有多少？

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

### @blackbaud/help-client 还在维护吗？

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