JavaScript diagramming library
JavaScript HTML Other
Pull request Compare This branch is 3 commits behind clientIO:master.
Failed to load latest commit information.
css RAP-797: All classes used internally now given joint- class name pref… May 31, 2016
demo RAP-797: All classes used internally now given joint- class name pref… May 31, 2016
dist Rebuilt dist files Jun 13, 2016
docs RAP-896: Added missing docs/tests (#332) May 31, 2016
plugins RAP-797: All classes used internally now given joint- class name pref… May 31, 2016
scripts More improvements to publish script. Jun 14, 2016
src fixed visibility of empty lines for FF (#337) Jun 7, 2016
test Fixes for webpack, browserify Jun 13, 2016
wrappers RAP-797: All classes used internally now given joint- class name pref… May 31, 2016
.bowerrc refactorize tests Apr 14, 2015
.csslintrc Added CSS linting Apr 11, 2016
.gitignore Fixes for test coverage task Apr 11, 2016
.jscsrc intoduce jscs, implement method for finding link connection points fo… Apr 12, 2015
.travis.yml RAP-896: Added missing docs/tests (#332) May 31, 2016
CHANGELOG Fixes for webpack, browserify Jun 13, 2016
Gruntfile.js Added npm prepublish hook (rebuilds dist files and runs tests) Jun 13, 2016
LICENSE first commit in version 0.6 Jul 19, 2013
Makefile Updates from upstream. Fixes for grunt file. Can now run tests via `n… Jan 18, 2016
README.md Add Vladimir as contributor (#310) Apr 29, 2016
bower.json Issue #223: Removed bower dependencies. Now using the dependencies in… Feb 2, 2016
index.js Use minified joint build file in index Jun 13, 2016
package.json Use bash script for publishing instead of using npm prepublish. The r… Jun 13, 2016

README.md

JointJS - JavaScript diagramming library

Build Status

JointJS is a JavaScript diagramming library. It can be used to create either static diagrams or, and more importantly, fully interactive diagramming tools and application builders.

Please see http://jointjs.com for more information, demos and documentation.

Features

  • basic diagram elements (rect, circle, ellipse, text, image, path)
  • ready-to-use diagram elements of well-known diagrams (ERD, Org chart, FSA, UML, PN, DEVS, ...)
  • custom diagram elements based on SVG or programmatically rendered
  • interactive elements and links
  • connecting diagram elements with links
  • customizable links, their arrowheads and labels
  • links smoothing (bezier interpolation)
  • magnets (link connection points) can be placed basically anywhere
  • hierarchical diagrams
  • serialization/deserialization to/from JSON format
  • highly event driven - you can react on any event that happens inside the paper
  • zoom in/out
  • touch support
  • plugin awareness
  • MVC architecture
  • ... a lot more

Supported browsers

Only the good ones (those that support SVG):

  • Latest Google Chrome (including mobile)
  • Latest Firefox
  • Safari (including mobile)
  • IE 9+

Development Environment

If you want to work on JointJS locally, use the following guidelines to get started.

Dependencies

Make sure you have the following dependencies installed on your system:

Setup

Clone this git repository:

git clone https://github.com/clientIO/joint.git

Change into the joint directory:

cd joint

Run installation

npm install

This will install all npm and bower dependencies as well as run a full build.

Tests

To run all tests:

grunt test

To run only the server-side tests:

grunt test:server

To run only the client-side tests:

grunt test:client

To run code style checks:

grunt test:code-style

Code Coverage

To output a code coverage report in lcov format for all unit tests:

grunt test:coverage --reporter="lcov"

The output will be saved to a new file named coverage.info at the root of the project directory.

Building Distribution Files

The dist directory contains pre-built distribution files. To re-build them, run the following:

grunt dist

Documentation

The source for the JointJS documentation (plus geometry and Vectorizer libraries) are included in this repository; see the docs directory. The documentation can be built into stand-alone HTML documents like this:

grunt build:docs

The output of the above command can be found at build/docs.

License

JointJS library is licensed under the Mozilla Public License, v. 2.0. Please see the LICENSE file for the full license.

Copyright (c) 2013 client IO

Contributors

Bitdeli Badge