5.x Beta docs

jsPlumb Toolkit

The jsPlumb Toolkit is a wrapper around the open source jsPlumb library that provides several key pieces of functionality:

The Toolkit version of jsPlumb has the Community version as a dependency. These docs refer to version 2.4.8 of the Toolkit edition, and version 2.15.5 of the Community edition.

Note Version 2.x of the Toolkit will soon be placed into a lightweight maintenance mode, as we are on the verge of releasing 5.x, which is currently in beta. You can read more about this on our blog. If you are looking for the documentation for version 5.x of the Toolkit edition, visit https://docs.jsplumbtoolkit.com/beta/.

This site provides the documentation for the Toolkit edition. For Community edition documentation, visit this page.

Demonstrations

In this git repository you will find source code and documentation for all of the demonstrations on the jsPlumb Toolkit site, plus a few more:

https://github.com/jsplumb-toolkit-demonstrations

Getting Started

The best place to get started familiarising yourself with the architecture of the Toolkit is to clone one of the demonstrations- either the Database Visualizer or the Flowchart Builder might be a good option, since they are fully-featured apps. If you're using Vue, Angular or React there are versions of these apps that use the appropriate library integration that ships with the Toolkit.

Alternatively, you might like to start with the documentation. The Data Model and Basic Concepts pages are the best places to start looking around. In a nutshell, the Toolkit uses a directed graph as its core data structure. Every app that has a need for jsPlumb - which is to say a need for the ability to connect entities - can be thought of in terms of a directed (or undirected) graph.