# @atlaskit/rovo-triggers 中文文档
规范地址：https://npmcn.com/package/%40atlaskit/rovo-triggers/
版本：12\.13\.1
npm 元数据更新时间：2026-11-05T21:32:15.633Z
中文译文更新时间：2026-11-07T02:40:38.916Z
软件包许可：Apache-2\.0
本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。
原始 npm 页面：https://www.npmjs.com/package/%40atlaskit/rovo-triggers
原文对照：https://npmcn.com/package/%40atlaskit/rovo-triggers/?lang=original
项目主页：https://bitbucket.org/atlassian/atlassian-frontend-mirror#readme
源码仓库：https://bitbucket.org/atlassian/atlassian-frontend-mirror
## 关键信息（来自 npm 元数据）
- 包体积（解压后）：351 kB，100 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：5 个
- peer 依赖：react ^18\.2\.0
- 首次发布：2024-10-18T10:29:26.611Z
- 最新版本发布：2026-11-05T21:32:15.451Z
- 近 30 天下载量：62310（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：243（近 12 个月 183 个）
## 中文简介
提供各种触发事件来驱动 Rovo Chat 功能, 如发布订阅和 URL 参数钩子
## 安装
```sh
npm install @atlaskit/rovo-triggers
```
也可以使用：`pnpm add @atlaskit/rovo-triggers`、`yarn add @atlaskit/rovo-triggers`、`bun add @atlaskit/rovo-triggers`
## README
# Rovo 触发器
_(原为谈话助理-pubsub)_
提供各种触发事件来驱动Rovo Chat的功能,例如发布订阅和 URL 参数钩头
## 示例用途
### 发布
```ts
import { usePublish } from "@atlaskit/rovo-triggers";
const YourComponent = () => {
const publish = usePublish('ai-mate');
const handleClick = () => {
publish({
type: "message-send",
data: "hello Rovo Chat",
source: "my-source", // source is used for analytics
})
}
return (
);
}
```
### 订阅
```ts
import { useSubscribe } from "@atlaskit/rovo-triggers";
const YourComponent = () => {
const [message, setMessage] = useState('Waiting for messages...');
useSubscribe({ topic: 'ai-mate' }, ({ type, data }) => {
if(type === 'message-received') {
setMessage(data)
}
});
return ({message}
);
}
```
#### 订阅( TriggerLasters)
```ts
import { useSubscribe } from "@atlaskit/rovo-triggers";
const YourComponent = () => {
const [message, setMessage] = useState('Waiting for messages...');
// This subscription will trigger immediately if an event has already been published to the 'ai-mate' topic
useSubscribe({ topic: 'ai-mate', triggerLatest: true }, ({ type, data, source }) => {
if(type === 'message-received') {
setMessage(data)
}
});
return ({message}
);
}
```
#### 装一次
出版商可将事件标记为 `consumeOnce: true` 只有一个挂起的例子 消费者应处理这一事件。 订阅者选择在稳定的情况下这样做 `consumeOnceKey`;共享相同密钥的订阅者将处理 a `consumeOnce` 事件总数. 无订阅者 `consumeOnceKey` 继续正常观察事件.
用于复制出版物的投递id由内部生成 `rovo-triggers` 没有 在事件有效载荷中暴露。 这破解了一个在多个挂载上发布扇形 订阅者;单独发布的呼叫作为单独事件处理.
```ts
const YourComponent = () => {
useSubscribe({ topic: 'ai-mate', consumeOnceKey: 'your-consumer' }, ({ type, data }) => {
if(type === 'message-send') {
sendMessage(data)
}
});
}
```
```ts
const AnotherComponent = () => {
const publish = usePublish('ai-mate');
const handleClick = () => {
publish({
type: 'message-send',
source: 'my-source',
consumeOnce: true,
data: { prompt: 'hello Rovo Chat' },
})
}
}
```
### 全部订阅
**说明** - 别用这个 现在它只是想成为Rovo Chat的代名词 当新事件发布时打开, 如果它还没有打开.
```ts
import { useSubscribeAll } from "@atlaskit/rovo-triggers";
const YourComponent = () => {
useSubscribeAll(() => {
console.log('pubsub received an event')
// do something like open the Rovo Chat panel
});
});
}
```
### 有条件地运行订阅
您可以有条件地调用一个使用 `triggerLatest` 通过有条件的 `` 组件。 这对确保你处于最佳状态有帮助 触发是订阅( 例如不再加载)
```ts
const YourComponent = ({ startSubscription }: { startSubscription: boolean }) => startSubscription ? (
{
if (type === 'message-send') {
setMsg(`${data} received at ${new Date().toLocaleTimeString()}`);
setCount(count + 1);
}
}}
/>
) : null
```
## 登记新事件
事件是一个主题和事件类型的组合. 因此,您可以通过 要么:
- 创建新 `Topic`,并利用现有 `EventTypes`
- 创建新 `Topic`,并创建一些新的 `EventTypes` 将使用
- 创建另一个 `EventType` 用于对付现有 `Topic`
这一点可能会随着效用和打字的演变而改变,因为要继续建立与此的结合 软件包.
### 专题
这个 `ai-mate` 主题被保留用于 `conversation-assistant` 事件,是唯一一个 当前存在。 看着这个空间.
### 事件类型
事件类型是指在Rovo Chat中发生的行动,或者您想引发的行动 在罗沃聊天室里 只要有一个注册 `publish` 活动 `ai-mate` 主题,你可以 订阅.
这项工作将随着一体化的发展而记录在案.
## 参数工具
Rovo Chat 使用很强的一组被编码的查询参数 `rovoChat` 用于 产品之间一致.
这些值可用于触发状态变化,路径,动作等.
- `clearPageRovoParams` - 从地址栏中删除rooChat参数和它的价值.
- `updatePageRovoParams` - 方便地增加属性 `rovoChat` 地址栏中的参数;这是 帮助不断更新用于书签或共享的URL。 这种方法使用 `addRovoParamsToUrl` 在引擎盖下.
- `addRovoParamsToUrl` - 前一个功能在引擎盖下使用,但你可以称之为 直接将它们添加到任意的 URL 字符串中, 因此让我们假设您想要从嵌入式中重定向 面板到阿特拉斯并做某种事情,你可以调用这个并传递所有所需的数据以确保 在阿特拉斯上
- `getRovoParams` - 你用来执行轨道参数中值的主要方法 能够执行 Atlas 页面路由,或触发嵌入式体验中的动作(根据 `UIConfig.fullScreen=false`(中文(简体) )
这里有一些你可能使用的例子 `getRovoParams` 结果值:
- 打开新聊天 `{ pathway: 'chat' }`
- 打开特定聊天 `{ pathway: 'chat', conversationId: '123' }`
- 打开与特定代理商的新聊天 `{ pathway: 'chat', agentId: '456' }`
- 打开特定代理聊天 `{ pathway: 'chat', conversationId: '123', agentId: '456' }`
- 打开新聊天并发送消息 `{ pathway: 'chat', prompt: 'What should I work on next?' }`
- 打开特定聊天并发送消息 `{ pathway: 'chat', conversationId: '123', prompt: 'What should I work on next?' }`
- 打开与 Rovo 行程归属的聊天 `{ pathway: 'chat', rovoJourneyId: '00000000-0000-4000-8000-000000000001' }`
- 打开特定代理聊天并发送消息 `{ pathway: 'chat', conversationId: '123', agentId: '456', prompt: 'What should I work on next?' }`
- 浏览代理 `{ pathway: 'agents-browse' }`
- 查看代理代理细节 `{ pathway: 'agents-browse', agentId: '456' }`
- 打开创建代理体验 `{ pathway: 'agents-create' }`
## 常见问题
### @atlaskit/rovo-triggers 是什么？
提供各种触发事件来驱动 Rovo Chat 功能, 如发布订阅和 URL 参数钩子
### 如何安装 @atlaskit/rovo-triggers？
在项目目录运行 npm install @atlaskit/rovo-triggers，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18\.2\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。
### @atlaskit/rovo-triggers 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
### @atlaskit/rovo-triggers 支持 ESM 还是 CommonJS？
同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。
### @atlaskit/rovo-triggers 可以商用吗？
@atlaskit/rovo-triggers 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。
### @atlaskit/rovo-triggers 的下载量有多少？
根据 npm 官方下载统计，@atlaskit/rovo-triggers 在 2026/10/07 – 2026/11/05 这 30 天内被下载 62,310 次，日均约 2,077 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
### @atlaskit/rovo-triggers 还在维护吗？
最新版本 12\.13\.1 发布于 2026/11/06（1 天前）；至今共发布 243 个版本，其中过去 12 个月发布了 183 个；首次发布于 2024/10/18。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。