A javascript library to create flowcharts

Flowy makes creating WebApps with flowchart functionality an incredibly simple task. Build automation software, mind mapping tools, or simple programming platforms in minutes by implementing the library into your project.

Based off Flowy made by Alyssa X

• Features
• Installation
• Running Flowy
  • Initialization
  • Example
• Callbacks
  • On grab
  • On release
  • On snap
  • On rearrange
• Methods
  • Get the flowchart data
  • Import the flowchart data
  • Delete all blocks

Currently, Flowy supports the following:

• Responsive drag and drop
• Automatic snapping
• Automatic scrolling
• Block rearrangement
• Delete blocks
• Automatic block centering
• Conditional snapping
• Conditional block removal
• Import saved files
• Mobile support
• Vanilla javascript (no dependencies)

Adding Flowy-v2 to your WebApp is incredibly simple:

1. Move flowy-v2.min.js and flowy-v2.min.css to your project.:

<link rel="stylesheet" href="flowy-v2.min.css"> 
<script src="flowy-v2.min.js"></script>

2. Create a canvas element that will contain the flowchart (for example, <div id="canvas"></div>)
3. Create the draggable blocks with the .create-flowy class (for example, <div class="create-flowy">Grab me</div>)

flowy(canvas, ongrab, onrelease, onsnap, onrearrange, spacing_x, spacing_y);

To define the blocks that can be dragged, you need to add the class .create-flowy

HTML

<div class="create-flowy">The block to be dragged</div>
<div id="canvas"></div>

Javascript

var spacing_x = 40;
var spacing_y = 100;
// Initialize Flowy
flowy(document.getElementById("canvas"), onGrab, onRelease, onSnap, onRearrange, spacing_x, spacing_y);
function onGrab(block){
	// When the user grabs a block
}
function onRelease(){
	// When the user releases a block
}
function onSnap(block, first, parent){
	// When a block snaps with another one
}
function onRearrange(block, parent){
	// When a block is rearranged
}

In order to use callbacks, you need to add the functions when initializing Flowy, as explained before.

function onGrab(block){
	// When the user grabs a block
}

Gets triggered when a user grabs a block with the class create-flowy

function onRelease(){
	// When the user lets go of a block
}

Gets triggered when a user lets go of a block, regardless of whether it attaches or even gets released in the canvas.

function onSnap(block, first, parent){
	// When a block can attach to a parent
	return true;
}

Gets triggered when a block can attach to another parent block. You can either prevent the attachment, or allow it by using return true;

function onRearrange(block, parent){
	// When a block is rearranged
	return true;
}

Gets triggered when blocks are rearranged and are dropped anywhere in the canvas, without a parent to attach to. You can either allow the blocks to be deleted, or prevent it and thus have them re-attach to their previous parent using return true;

// As an object
flowy.output();
// As a JSON string
JSON.stringify(flowy.output());

The JSON object that gets outputted looks like this:

{
	"html": "",
	"blockarr": [],
	"blocks": [
		{
			"id": 1,
			"parent": 0,
			"data": [
				{
				"name": "blockid",
				"value": "1"
				}
			],
			"attr": [
				{
				"id": "block-id",
				"class": "block-class"
				}
			]
		}
	]
}

Here's what each property means:

flowy.import(output)

Allows you to import entire flowcharts initially exported using the previous method, flowy.output()

This method accepts raw HTML and does not sanitize it, therefore this method is vulnerable to XSS. The only safe use for this method is when the input is absolutely trusted, if the input is not to be trusted the use this method can introduce a vulnerability in your system.

To remove all blocks at once use:

flowy.deleteBlocks()

To remove a single block use:

flowy.deleteBlock(blockId)

To remove a block and its sub-tree use:

flowy.deleteBranch(blockId)

To add a block use:

flowy.add(blockEl, parentId)