Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
jQuery/MooTools/YUI3 Javascript library that lets you connect parts of your UI together.

This branch is 1532 commits behind sporritt:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
archive
build
demo
img
js
lib
tests
README.md
build.xml
changelog.txt
todo.txt

README.md

jsPlumb

jsPlumb provides a means for a developer to visually connect elements on their web pages. It uses SVG or Canvas in modern browsers, and VML on IE 8 and below. The latest version is 1.3.11.

The project started out life on Google Code and has been hosted there for the last two years; from version 1.3.4 onwards it also lives here on GitHub. The source repo is now being synchronised between the two. I did this because I didn't want to lose the project history (issues etc), and I know some people checkout the source from Google Code.

All issues should be reported on Google Code until I can import everything from there at once.

For users upgrading from earlier versions to 1.3.x - there are a few minor backwards incompatibilities. Please see the changelog.

If you're new to jsPlumb, please do take the time to read the documentation. There are a few integration issues that you should be aware of: z-index needs special attention, for example.

Requirements

  • jQuery:

jsPlumb requires jQuery 1.3.x or later; it has been tested on 1.3.2, 1.4.2, 1.4.3, 1.4.4, 1.5.0, 1.6.0 and 1.7.1. To support dragging, you will need jQueryUI 1.7.x or 1.8.x. I've tested both.

There is a bug in jQuery 1.6.x and 1.7.x's SVG support for IE9 - see this issue. It means that mouse events do not get posted. This is quite a bummer since the default renderer for jsPlumb, from 1.3.4 onwards, is SVG, and I was hoping to encourage everyone to make use of the fact that you can use CSS with SVG to style your plumbing rather than rely on the old-skool paintStyle stuff. There is another discussion of the issue here

  • MooTools:

jsPlumb requires MooTools 1.3.x or 1.2.4 (tested on 1.3.2 and 1.2.4; it might work on other versions). To support dragging in MooTools, you will need Drag.Move from MooTools More. jsPlumb has been tested with Drag.Move from MooTools More 1.3.2.1 and 1.2.4.4, but I would recommend using 1.3.2.1 as there were bugs on IE with the getPosition() function of MooTools, which the Drag.Move class uses.

Firefox 11 and MooTools 1.3.x do not play well together in SVG mode - see this issue

  • YUI3:

jsPlumb requires YUI 3.3.x (tested on 3.3.0; it actually might work on other versions). You do not need to include anything other than 'node' in your code that works with jsPlumb, but due to the asynchronous nature of module loading with YUI, you need to ensure you use jsPlumb's ready function to wrap your initialisation code, or you cannot be sure that everything that is required is available:

jsPlumb.ready(function() { 
  ...
}); 

jsPlumb in action

Links to various demonstrations can be found here.

TweetPlumb is a great Twitter visualisation built (I say it's great because I built it myself!) using jsPlumb.

Documentation

Documentation can be found in the doc folder of the project, or you can view it online here.

API documentation is in the apidoc folder of the project, and online here.

The Bezier curve functions used by jsPlumb have been extracted to a separate project:

https://github.com/sporritt/jsBezier

Tests

qUnit test suite can be found here

Twitter

The Twitter account I use for this project is jsplumblib

..but of course things fall through the cracks with Twitter. So maybe use this instead:

Mailing List

Sign up for the jsPlumb announcements mailing list here.

License

All 1.x.x versions of jsPlumb are dual-licensed under both MIT and GPL version 2.

Something went wrong with that request. Please try again.