Skip to main content

jsPlumb Toolkit#

The jsPlumb Toolkit offers a set of packages to assist you in rapidly building powerful applications whose focus is on visual connectivity. Some key features of the Toolkit are:

note

These docs refer to version 5.x. For the 2.x documentation, see this page. You can read more about the 5.x release on our blog.

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

Getting Started#

A good way to get started familiarising yourself with the architecture of the Toolkit is to clone one of the demonstrations discussed below - either the Database Visualizer or the Flowchart Builder might be a good option, since they are fully-featured apps, and also they offer examples in Typescript, ES6 and ES5. 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.

The Data Model page is a good place to start looking around when you want to familiarise yourself with the way the Toolkit models the world. 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.

Demonstrations#

In this GitHub organisation 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

The main branch of each of these demonstrations is setup for version 5.x of the Toolkit.