LogicFlow

<p align="center"> <a href="https://site.logic-flow.cn" target="_blank"> <img src="https://site.logic-flow.cn/logo.png" alt="LogicFlow logo" width="100" /> </a> </p> <p align="center"> <a href="https://www.npmjs.com/package/@logicflow/core"> <img src="https://img.shields.io/npm/v/@logicflow/core" alt="Version"> </a> <a href="https://www.npmjs.com/package/@logicflow/core"> <img src="https://img.shields.io/npm/dm/@logicflow/core" alt="Download"> </a> <a href="https://github.com/didi/LogicFlow/blob/master/LICENSE"> <img src="https://img.shields.io/npm/l/@logicflow/core" alt="LICENSE"> </a> </p>

简体中文 | English

LogicFlow 是一款流程图编辑框架，提供了一系列流程图交互、编辑所必需的功能和简单灵活的节点自定义、插件等拓展机制，方便我们快速在业务系统内满足类流程图的需求。

核心能力

• 可视化模型：通过 LogicFlow 提供的直观可视化界面，用户可以轻松创建、编辑和管理复杂的逻辑流程图。
• 高可定制性：用户可以根据自己的需要定制节点、连接器和样式，创建符合特定用例的定制逻辑流程图。
• 灵活易拓展: 内置提供丰富的插件，用户也可根据自身需求定制复杂插件实现业务需求。
• 自执行引擎: 执行引擎支持浏览器端执行流程图逻辑，为无代码执行提供新思路。
• 数据可转换：支持 LogicFlow 数据与 BPMN、Turbo 等各种后端执行引擎数据结构转换能力。

安装

# npm
$ npm install @logicflow/core @logicflow/extension --save

# yarn
$ yarn add @logicflow/core @logicflow/extension

# pnpm
$ pnpm add @logicflow/core @logicflow/extension

快速上手

<!-- LogicFlow 容器 DOM-->
<div id="container"></div>;

// 准备数据
const data = {
  // 节点
  nodes: [
    {
      id: '21',
      type: 'rect',
      x: 100,
      y: 200,
      text: '矩形节点',
    },
    {
      id: '50',
      type: 'circle',
      x: 300,
      y: 400,
      text: '圆形节点',
    },
  ],
  // 边
  edges: [
    {
      type: 'polyline',
      sourceNodeId: '50',
      targetNodeId: '21',
    },
  ],
};
// 渲染画布
const lf = new LogicFlow({
  container: document.querySelector('#container'),
  width: 700,
  height: 600,
});

lf.render(data);

相关文档

官方文档

• 快速上手
• 图表示例
• 相关文章

---

• 更新日志
• issue模板

本地开发

# 安装项目依赖和初始化构建
$ pnpm install

# 进入到指定项目开发和调试
cd packages/core
pnpm run build:watch

# 启动 example 查看效果
cd examples/feature-examples
pnpm run start

参与共建

如果希望参与到 LogicFlow 的开发中，请遵从我们的贡献指南。如果你贡献度足够活跃，你可以申请成为社区协作者。

<a href="https://github.com/didi/LogicFlow/graphs/contributors"> <img src="https://raw.githubusercontent.com/didi/LogicFlow/master/CONTRIBUTORS.svg" alt="Contributors" /> </a>

Star History

<a href="https://www.star-history.com/#didi/LogicFlow&Date"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=didi/LogicFlow&type=Date&theme=dark" /> <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=didi/LogicFlow&type=Date" /> <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=didi/LogicFlow&type=Date" /> </picture> </a>

开源协议

该项目的代码和文档基于 Apache-2.0 License 开源协议。