adrai/flowchart.js
Flowchart.js
Flowchart.js is a JavaScript library that converts a simple text-based domain-specific language into SVG flowcharts. It parses DSL keywords to define node types such as start, end, operation, condition, parallel, and subroutine, then renders them as distinct SVG shapes connected by directional paths.
The library distinguishes itself through its styling and interactivity capabilities. It supports applying CSS classes to SVG elements for external stylesheet overrides, as well as inline attribute overrides for per-node and per-edge visual properties like fill, stroke, and font. Flowchart.js also enables state-driven visual mapping, where semantic states such as past, current, or future are assigned predefined color and opacity values to reflect process progress. Additionally, it allows embedding clickable hyperlinks within nodes for external URL navigation.
Beyond core rendering, the tool provides options for customizing diagram appearance, including colors, fonts, line widths, and arrow styles. It supports conditional and parallel branches with custom labels, and allows styling individual flowchart symbols or connections directly within the DSL syntax. The library is distributed as a JavaScript package with documentation covering its DSL syntax and API.
Features
- Flowchart Rendering - Renders SVG flowcharts by parsing a simple text-based DSL that defines nodes and connections.
- SVG Diagramming Libraries - Generates SVG flow chart diagrams from textual representations without requiring a graphical editor.
- Diagram Edge Routers - Links nodes using the arrow operator and specifies connection directions to control the flow layout.
- Flowchart DSL Parsers - Parses a custom DSL that defines nodes, connections, and visual styles into structured diagram data.
- Flowchart Symbol Renderers - Maps each DSL keyword to a distinct SVG shape (rectangle, diamond, parallelogram) for flowchart symbols.
- SVG Path Routers - Computes SVG path coordinates from node connections and arrow directions to produce routed edges.
- DSL-to-SVG Parsers - Parses a domain-specific language into an abstract syntax tree and renders it as SVG graphics.
- Branch-Labeled Paths - Directs flow into multiple paths from condition or parallel nodes with custom branch labels.
- Labeled Branch Paths - Models decision points and concurrent branches in a process with labeled paths.
- Text-to-Diagram Generators - Converts a text-based DSL into SVG flowcharts for documentation and planning purposes.
- Flowchart Node Types - Supports multiple node shapes like start, end, operation, condition, parallel, and subroutine for flowchart steps.
- External Hyperlinks - Embeds clickable SVG anchor elements around nodes to support external URL navigation.
- URL-Attached Nodes - Attaches clickable URLs to flowchart nodes for navigation to external resources or details.
- Customizable Flowchart Stylers - Ships per-node and per-edge styling overrides for fill, stroke, font, and CSS classes directly in the DSL.
- Progress-Annotated Flowcharts - Annotates flowchart nodes with statuses like past, current, or approved to track process progress.
- State-Annotated Flowcharts - Assigns visual states such as past, current, future, approved, or rejected to flowchart elements.
- Symbol-Specific Stylers - Sets distinct colors, fonts, and CSS classes for specific symbol types such as start, end, or process nodes.
- Node URL Attachers - Attaches clickable hyperlinks to any node that open in a new tab or navigate the current page.
- Graph Connection Styling - Applies custom stroke colors, widths, and arrow styles to individual nodes or connection paths directly in the DSL.
- Diagram Element Styling - Applies visual styling options like colors, fonts, line widths, and arrow styles to the generated flowchart.
- State-Driven Visuals - Maps semantic states (past, current, future) to predefined color and opacity values for progress visualization.
