Skip to content

数据流光效边 (DataFlowEdge)

DataFlowEdgeyh-flow 独有的高级可视化连线组件,专为 AI 工作流编排实时数据管道等场景设计。 只需在 edge.data 中设置 flowStatusflowEffect,即可让每条连线随状态呈现粒子流动、发光、心跳、波浪四种视觉动效。

快速上手

只需两步:注册组件 → 在 edge.data 里配置状态

typescript
// 步骤 1:注册为自定义边类型
import { markRaw } from 'vue'
import { DataFlowEdge } from '@yh-ui/flow'

const edgeTypes = { dataflow: markRaw(DataFlowEdge) }

// 步骤 2:在 edges 数组的 data 字段中配置状态和动效
const edges = ref([
  {
    id: 'e1',
    source: 'node-a',
    target: 'node-b',
    type: 'dataflow', // 对应步骤 1 注册的 key
    label: '处理中',
    data: {
      flowStatus: 'processing', // 状态:idle | processing | success | error | warning
      flowEffect: 'particles' // 动效:particles | glow | pulse | wave | none
    }
  }
])

IMPORTANT

flowStatusflowEffect 等配置项必须放在 edge.data 对象里,而不是 edge 的顶层字段。组件会自动从 edge.data 中读取这些值。

5 种状态演示

处理中
成功
失败
警告
数据源 1
数据源 2
数据源 3
数据源 4
汇聚节点
processing/success/error/warning/idle 全状态预览

动态切换状态与动效

状态动效
节点 A
节点 B
节点 C
节点 D
实时切换状态与动效,体验全部组合效果

状态说明

flowStatus颜色动画特征典型场景
idle灰色无动画静止连线、待机状态
processing紫色线条呼吸数据传输中、API 请求中
success绿色稳定发光传输完成、节点执行成功
error红色快速闪烁传输失败、节点出错
warning橙色慢速脉冲超时告警、数据异常

动效说明

flowEffect描述最佳搭配状态
particles发光粒子沿曲线路径流动processing
glow线条持续发光光晕success
pulse线条亮度心跳闪烁(JS interval)error / warning
waveCSS 虚线流动动画processing / 通用
none无特殊动效,颜色仍随状态变化全部

API

edge.data 配置项

这些字段写在 Edge 的 data 对象中

字段类型默认值说明
flowStatusDataFlowStatus'idle'状态,决定颜色与 CSS 动画
flowEffectDataFlowEffect'particles'视觉动效类型
glowIntensitynumber8发光模糊强度(0–20)
particleCountnumber3粒子数量(1–10)
animationDurationnumber2粒子/pulse 动画周期(秒)

Edge 标准字段

字段类型说明
typestring设为注册的 key,如 'dataflow'
labelstring连线中心标签文字
animatedboolean设为 true 时 idle 状态显示虚线流动
selectedboolean是否高亮选中状态

类型定义

typescript
type DataFlowStatus = 'idle' | 'processing' | 'success' | 'error' | 'warning'
type DataFlowEffect = 'particles' | 'glow' | 'pulse' | 'wave' | 'none'

注册为自定义边类型

typescript
import { markRaw } from 'vue'
import { DataFlowEdge } from '@yh-ui/flow'

// 在 yh-flow 的 :edge-types 中注册
const edgeTypes = {
  dataflow: markRaw(DataFlowEdge)
  // 可同时注册多个自定义边类型
}

TIP

edges 定义为 computed,将状态(如来自 Pinia store 的运行时数据)映射到 edge.data,可轻松实现 AI 工作流节点运行状态的实时可视化

下一步

Released under the MIT License.