# @guardian/braze-components 中文文档

规范地址：https://npmcn.com/package/%40guardian/braze-components/

版本：23\.0\.2
npm 元数据更新时间：2026-06-24T11:38:08.127Z
中文译文更新时间：2026-11-17T02:44:57.003Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：358 kB，133 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：24\.2
- 运行依赖：0 个
- peer 依赖：@emotion/react 11\.1\.2，@guardian/libs 27\.1\.0，@guardian/source 12\.2\.0，react 17\.0\.2 \|\| 18\.2\.0
- 首次发布：2020-08-11T09:22:30.023Z
- 最新版本发布：2026-06-24T11:38:07.719Z
- 近 30 天下载量：15859（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：96（近 12 个月 2 个）

## 中文简介

从 Braze 发送消息的响应组件

## 安装

```sh
npm install @guardian/braze-components
```

也可以使用：`pnpm add @guardian/braze-components`、`yarn add @guardian/braze-components`、`bun add @guardian/braze-components`

## README

# 气相组件

用于在 DCR 和 DCR 上显示 Braze 信件的 React 组件库 前门.

Braze信息以两种方式被曝光,以解决两个独立的使用案例.

1.  一发信息
2.  持久性通知

使用一发消息 [Braze的应用信息](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/in-app_messaging/overview/) 以显示用户的单个信件印象。 这对广告来说太无聊了 感觉。 和广告一样,这些讯息经常与其他的 用于页面共享消息槽的系统。 这些消息被曝光了 编辑 [灰尘](https://npmcn.com/package/%40guardian/braze-components/src/logic/BrazeMessages.tsx) 课.

持续通知由 [Braze 内容卡](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/content_cards/data_models/)。 。 。 . 这些通知一直持续到驳回为止(自动或由 用户),或过期. 不同来源的通知可以 彼相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相 这些通知被秘书处披露 [布雷泽卡](https://npmcn.com/package/%40guardian/braze-components/src/logic/BrazeCards.ts) 课.

## 发展

### 本地设置

```
$ bin/setup
```

### 故事书

我们用故事书来构建组件。 运行故事本 :

```
$ pnpm storybook
```

故事书中的网格图像拾取器集成需要auth. 必要时 你会被引导到 [gutools 登录服务](https://github.com/guardian/login.gutools)在发展时,这意味着 运行本地登录服务。 通常开发时你不需要使用 图像采集器。 在这种情况下,您可以通过运行"故事本"来完全跳过 Auth 像这样:

```
$ STORYBOOK_DISABLE_AUTH=true pnpm storybook
```

这意味着你不需要在当地运行登录服务.

### 指向您本地版本的 @ guardian/ braze- 组件

有时测试一个胸罩组件 改变对一个本地 运行使用它的项目的版本,例如 DCR.

建议使用 [`yalc`](https://github.com/wclr/yalc) 这样做.

#### 安装雅尔克

执行指令 [雅尔克读取](https://github.com/wclr/yalc#installation)。 。 。 .

#### 在本地建立 @ guardian/ braze- 组件

```
$ pnpm build
```

#### 将您的本地@ guardian/ braze- 组件发布到本地雅尔克注册簿

在本地的检查中 `@guardian/braze-components`,在词根中:

```
$ yalc publish
```

#### 使用本地 yalc 登记册中的 braze 组件

```
$ yalc add @guardian/braze-components
```

例如,对 DCR 来说,它应该从dotcom 传输内部运行 次级项目.

这将更新本地软件包. json 和 yalc ref. 这是预期的,但 改变不应该被承诺.

#### 页:1

以上步骤在修改胸罩组件时应当重复 你想看看本地情况 别忘了再跑 `pnpm build`来啊!

## 向国家预防机制公布

向国家防范机制的释放 [变化](https://github.com/changesets/changesets) 由CI执行.

在您的特性分支上, 在合并前运行 `pnpm changeset`. 这将 交互式地询问这是什么变化(主要、小、补丁)和 允许您描述变化。 将生成的更改et文件提交 git 和 推向你的树枝.

当您合并分支时,将自动打开一个版本的放出PR. 合并后,将再次向国家预防机制发布。 版本更改 将基于您更改器文件中的信息。 如果版本发布 公关不是马上合并的 没关系 任何其他有更改的 PR 合并 与此同时,将更新发布公关.

并不是所有的公关都要求释放,因此不需要一个变换器. 举个例子 修改读取器.

### 合并到主后的步骤

对于dotcom-递归:

-   运行 `checkout` 主树枝和取出
-   运行 `checkout -b` 启动更新 PR 的新分支
-   更新对胸罩组件的依赖性 `dotcom-components/dotcom-components/package.json`
-   运行 `pnpm` 更新 DCR 根中的 pnpm.lock 文件
-   推出分行并创建GitHub的PR.
-   如果修改涉及组件的视觉变化,请通过截图捕捉并包含在 PR 中
-   如果更改涉及更新到组件布局, 在 DCR 故事簿文件中添加代码以反映这些更改
-   如有必要(并不总是如此),请接受 `DCR CODE` (第一个通知在 `P&E/Dotcom CODE Semaphore` 并在那里部署代码.
-   如果一切都好,并批准公关,则将公关合并为主(以 GitHub 为单位)

对于前端 :

-   运行 `checkout` 主树枝和取出
-   运行 `checkout -b` 启动更新 PR 的新分支
-   更新/package.json中的胸罩组件依赖性
-   运行 `make install compile` 以更新依赖锁文件
-   推出分行并创建GitHub的PR.
-   如有必要(并不总是如此),请接受 `Frontend CODE` (第一个通知在 `P&E/Dotcom CODE Semaphore` 并在那里部署代码.
-   如果一切都好,并批准公关,则将公关合并为主(以 GitHub 为单位)

## 排雷中心/发改委

当您推动到 GitHub 动作时, 将触发运行 Jest 测试 TypeScript 编译器等. 还将启动TeamCity建设。 打开 `main` 如果 TeamCity 构建成功 Riff Raff 将部署 Storybook 到 [https://braze-communitys.gutools.co.uk 页面存档备份,存于互联网档案馆](https://braze-components.gutools.co.uk/)。 。 。 .

## 常见问题

### @guardian/braze-components 是什么？

从 Braze 发送消息的响应组件

### 如何安装 @guardian/braze-components？

在项目目录运行 npm install @guardian/braze-components，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@emotion/react（11\.1\.2）、@guardian/libs（27\.1\.0）、@guardian/source（12\.2\.0）、react（17\.0\.2 \|\| 18\.2\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @guardian/braze-components 支持 TypeScript 吗？

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

### @guardian/braze-components 支持 ESM 还是 CommonJS？

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

### @guardian/braze-components 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js 24\.2。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @guardian/braze-components 可以商用吗？

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

### @guardian/braze-components 的下载量有多少？

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

### @guardian/braze-components 还在维护吗？

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

