AgentRunBar 任务运行状态

用于展示智能体任务的运行状态,包括运行时长、当前状态和操作按钮。支持运行中、暂停、停止、完成、出错、取消等多种状态切换和交互操作。

历史名称为 TaskRunning,已重命名为 AgentRunBar,原 TaskRunning 仍以别名形式导出但已废弃,新代码请使用 AgentRunBar。

何时使用

  • 智能体执行后台任务时,向用户展示运行进度与可控操作
  • 需要呈现任务运行 / 暂停 / 停止 / 完成 / 错误 / 取消 等状态
  • 需要在状态发生变化时提供「暂停 / 继续 / 停止 / 重试 / 新建任务 / 查看结果」入口

代码演示

AgentRunBar - 全状态演示

API

AgentRunBarProps

属性说明类型默认值版本
actionsRender自定义操作按钮(不影响 stop/pause/resume 控制按钮)AgentRunBarActionsRender | false--
className自定义类名string--
description描述文案string--
icon自定义图标React.ReactNode--
iconTooltip图标提示文案string--
locale国际化配置(覆盖默认按钮文案){ agentRunBar?: AgentRunBarLocale }--
onCreateNewTask创建新任务的回调() => void--
onPause暂停任务的回调() => void--
onReplay重新执行任务的回调() => void--
onResume继续任务的回调() => void--
onStop停止任务的回调() => void--
onViewResult查看任务结果的回调() => void--
style自定义样式React.CSSProperties--
taskRunningStatus任务运行过程态TaskRunningStatus--
taskStatus任务宏观状态(终态或主流程态)TaskStatus--
title标题文案string--
variant主题样式变体'simple' | 'default''default'-

actionsRender 三态语义:

  • undefined:使用内置默认 actionNode(依据 taskStatus / taskRunningStatus 自动选择)
  • false:不渲染任何自定义 actionNode;停止 / 暂停 / 继续控制按钮仍按状态显示
  • 函数:调用并将其返回值作为 actionNode 渲染(返回 false / null 等同于不渲染)

类型定义

TaskStatus

任务宏观状态联合类型。

type TaskStatus =
  | 'running' // 任务正在运行中
  | 'success' // 任务已成功完成
  | 'error' // 任务执行出错
  | 'pause' // 任务已暂停
  | 'stopped' // 任务已停止
  | 'cancelled'; // 任务已取消

同名常量对象 TASK_STATUS(如 TASK_STATUS.RUNNING)作为向后兼容保留;推荐直接使用字符串字面量以获得更好的 tree-shaking。

TaskRunningStatus

任务运行过程态联合类型,用于细粒度控制机器人动画与按钮显示。

type TaskRunningStatus =
  | 'running' // 正在运行中
  | 'complete' // 已完成
  | 'pause'; // 已暂停

同名常量对象 TASK_RUNNING_STATUS 作为向后兼容保留。

AgentRunBarVariant

type AgentRunBarVariant = 'simple' | 'default';

AgentRunBarActionsRender

自定义操作按钮渲染函数类型。

type AgentRunBarActionsRender = (props: {
  status?: TaskStatus;
  runningStatus?: TaskRunningStatus;
}) => React.ReactNode;

locale.agentRunBar

字段说明默认值(中文)
play继续按钮 tooltip继续
pause暂停按钮 tooltip暂停
stop停止按钮 tooltip停止
createNewTask新建任务按钮文案新任务
replayTask重新执行按钮文案重新执行
newTask新任务按钮文案新任务
submitTask提交任务按钮文案提交任务

别名(向后兼容)

历史名称新名称说明
TaskRunningAgentRunBar组件别名,已废弃
TaskRunningPropsAgentRunBarProps类型别名,已废弃
TaskRunningVariantAgentRunBarVariant类型别名,已废弃
TaskRunningActionsRenderAgentRunBarActionsRender类型别名,已废弃

旧名称仍可正常导入,但会在未来大版本移除,请优先使用 AgentRunBar 系列名称。