Skip to main content
Version: 4.3

What's in the JointJS+ package?

Do you want to explore the JointJS+ package? Read about the files, folders & applications to get started!

Getting the JointJS+ package​

The recommended way to install JointJS+ is via our private npm registry. You can also download JointJS+ as a ZIP archive from the customer portal or sign up for a free 30-day trial.

Files & FoldersDescription
packages/JointJS+ installable packages
CHANGELOGA record of all notable changes in JointJS & JointJS+
LICENSELicense detailing permitted use JointJS+
README.mdInformation about the JointJS+ package

Files & Folders in depth​

build​

This folder is available to Enterprise customers only.

build/ contains additional JointJS and JointJS+ build files.

packages​

packages/ contains a joint-plus/ directory that has several files of interest including the JointJS+ installable package joint-plus.tgz:

  • joint-plus.tgz
  • joint.plus.mjs
  • joint-plus.js (UMD format)
  • joint-plus.css (If using the UMD format, include a separate CSS file)

The packages/ directory also has joint-format-bpmn-export/, joint-format-bpmn-import/, joint-format-visio/, joint-react-plus/ and joint-shapes-vsm/ directories that contain their respective files. The installable package files are as follows:

  • joint-bpmn-export.tgz
  • joint-bpmn-import.tgz
  • joint-visio.tgz
  • joint-react-plus.tgz
  • joint-vsm-shapes.tgz

src​

This folder is available to Enterprise customers only.

src/ contains the source code for each JointJS+ plugin.

Sample apps​

JointJS+ comes with various demo apps including their source code, available in our public GitHub repository. Exploring the apps' source code is the best way to get to know the framework. You can even use the apps as a boilerplate for your own applications, and customize them to your needs. See the Demo apps guide for instructions on how to browse and download them.