Skip to content

Commit ea17d7c

Browse files
authored
Merge pull request #1 from lornakelly/release-diagram-editor-mvp-1.0.0
Diagram Editor MVP Release
2 parents 3fe791f + f5cb283 commit ea17d7c

1 file changed

Lines changed: 114 additions & 0 deletions

File tree

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
---
2+
title: Announcing the Open Workflow Specification Diagram Editor (MVP)
3+
author: Lorna Kelly
4+
date: 2026-07-21
5+
description: >
6+
The first MVP release of the Open Workflow Diagram Editor - a React component that turns your workflow definitions into interactive diagrams. Compatible with Specification 1.0.0.
7+
---
8+
9+
🎉 We're excited to share the first **MVP release** of the [**Open Workflow Diagram Editor**](https://www.npmjs.com/package/@openworkflowspec/diagram-editor) — a new React component that renders your Open Workflow definitions as interactive diagrams. It's the first step toward a full visual editing experience for the Open Workflow ecosystem, and it's ready for you to try today.
10+
11+
## What is the Diagram Editor?
12+
13+
The Diagram Editor (`@openworkflowspec/diagram-editor`) is a React component that takes a **Open Workflow Specification 1.0.0** definition - in YAML or JSON - and visualizes it as an interactive, automatically laid-out diagram.
14+
15+
It's built on top of the tools the community already knows:
16+
17+
- The **[Open Workflow TypeScript SDK](https://github.com/open-workflow-specification/sdk-typescript)** for parsing and understanding workflow definitions.
18+
- **[React Flow (`@xyflow/react`)](https://reactflow.dev/)** for diagram rendering and interaction.
19+
- **[ELK](https://www.eclipse.org/elk/)** for automatic graph layout, so your workflows are arranged cleanly without any manual positioning.
20+
21+
## What's in the MVP
22+
23+
This first release focuses on **visualizing** workflows. Here's what you get:
24+
25+
-**Spec 1.0.0 support** - render any Open Workflow 1.0.0 definition straight from YAML or JSON.
26+
-**Interactive diagram** - pan, zoom, and explore your workflow with automatic layout.
27+
-**Light / dark / system color modes** — the editor adapts to your application's theme.
28+
-**Internationalization** — built-in support for multiple locales (English only to start).
29+
-**Modern React component** — a React 19 component you can embed into your own apps.
30+
-**Schema validation** — definitions are checked against the Open Workflow 1.0.0 schema, with clear feedback when something doesn't conform.
31+
-**Graceful error handling** — clear parsing-error feedback when a definition can't be rendered.
32+
33+
## A quick look
34+
35+
The component takes your workflow definition as a string and renders it:
36+
37+
```tsx
38+
import { DiagramEditor } from "@openworkflowspec/diagram-editor";
39+
import "@openworkflowspec/diagram-editor/styles.css";
40+
41+
const workflow = `
42+
document:
43+
dsl: '1.0.0'
44+
namespace: default
45+
name: hello-world
46+
version: '1.0.0'
47+
do:
48+
- step1:
49+
set:
50+
message: hello world
51+
`;
52+
53+
export function App() {
54+
return (
55+
<DiagramEditor
56+
content={workflow}
57+
isReadOnly={true}
58+
locale="en"
59+
colorMode="system"
60+
/>
61+
);
62+
}
63+
```
64+
65+
> **Note:** This MVP is focused on visualization. Interactive, in-place editing of workflows is on the roadmap — for now, `isReadOnly` keeps the experience clear and predictable.
66+
67+
## Try it now
68+
69+
The Diagram Editor is available on npm:
70+
71+
```bash
72+
npm install @openworkflowspec/diagram-editor
73+
# or
74+
pnpm add @openworkflowspec/diagram-editor
75+
# or
76+
yarn add @openworkflowspec/diagram-editor
77+
```
78+
79+
Then drop the component into your app as shown above.
80+
81+
Prefer to explore the source or see it running end to end? Clone the repository and launch the live Storybook demo, which comes with example workflows and use cases so you can see the component in action and explore the API:
82+
83+
```bash
84+
# Clone the repository
85+
git clone https://github.com/open-workflow-specification/editor.git
86+
cd editor
87+
88+
# Install dependencies (Node.js 22, pnpm 10.31.0)
89+
pnpm install
90+
91+
# Build the packages
92+
pnpm run build:dev
93+
94+
# Run the Storybook demo for the diagram editor
95+
cd packages/open-workflow-diagram-editor
96+
pnpm run start
97+
```
98+
99+
## What's next
100+
101+
This MVP is just the beginning. On the roadmap:
102+
103+
- ✏️ **Interactive editing** — moving from visualization to a full visual editor.
104+
- 🔀 **Dual text + diagram editor** — edit your workflow as text, with both views kept in sync.
105+
- 🧩 **VS Code extension** — bringing the editor into your IDE.
106+
107+
## Get involved
108+
109+
The Open Workflow Diagram Editor is an open, community-driven project, and we'd love your feedback, ideas, and contributions.
110+
111+
-**Explore the code**: [open-workflow-specification/editor](https://github.com/open-workflow-specification/editor)
112+
-**Report issues or request features**: [editor issues](https://github.com/open-workflow-specification/editor/issues)
113+
114+
Happy coding! 🚀

0 commit comments

Comments
 (0)