Skip to main content

Version 5.x Beta

· 3 min read
Simon Porritt

Over the last several months, jsPlumb - both the Community and Toolkit editions - has been ported into Typescript, undergoing various refactoring and API changes along the way, with the goal of producing a version of jsPlumb that is:

  • smaller
  • faster
  • tree shakeable
  • better documented

In version 5.x, the version numbering for the Toolkit and Community editions will be kept in sync: a release containing changes only to the Community edition will result in a corresponding Toolkit edition release, even though it contains no changes, and vice-versa. Keeping the version numbers in sync in this way takes a certain amount of guesswork out of the equation.

I'm pleased to share that we're almost ready to release version 5.0.0. Over the next few weeks I'll be running a series of "howto" posts, short posts that discuss one aspect of using jsPlumb, both the Community and Toolkit editions, in a modern web app.

Installation#

Community edition#

You can already try version 5.x of the Community edition - it's on npm (albeit with an RC version suffix):

npm i @jsplumb/browser-ui

This package is the equivalent of the jsPlumb window global that users of 2.x will be familiar with. It's been on npm for a couple of months now and is used quite extensively already, so don't let the RC version suffix put you off. You can browse the documentation here.

Toolkit edition#

For licensees or evaluators of the Toolkit edition, version 5.x is also available, hosted in jsPlumb's own npm repo. If you'd like to check it out, you can register your interest here.

Documentation for version 5.x of the Toolkit edition can be found here.

What happens to 2.x?#

It depends on which version you're talking about. For the Community edition, 2.x is now very much in maintenance mode, and is unlikely to receive any updates unless the current 2.x version of the Toolkit requires it. Users of the Community edition are strongly encouraged to migrate to 5.x now.

For licensees/evaluators of version 2.x of the Toolkit edition, when 5.x is released the current version will switch into a lightweight maintenance mode, which is to say that any bugs reported will be fixed, and, wherever possible, any new features added to 5.x that can also be added to 2.x without major dev work will be added to 2.x. When the support window closes for the last 2.x licensee at some point in the future, the 2.x version of the Toolkit will enter a stricter maintenance mode. When version 5.x of the Toolkit is released it will also not be possible for new evaluators/licensees to download version 2.x of the Toolkit edition.