Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Draws simple SVG sequence diagrams from textual representation of the diagram
branch: master

This branch is 84 commits behind bramp:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
_site @ e1793c3
fonts/daniel
src
test
.gitignore
.gitmodules
Makefile
README.md
sequence-diagram-min.js

README.md

JS Sequence Diagrams (we need a better name!)

Generates UML sequence diagrams from simple text
http://bramp.github.com/js-sequence-diagrams/

by Andrew Brampton 2012

Example

We turn

Alice->Bob: Hello Bob, how are you?
Note right of Bob: Bob thinks
Bob-->Alice: I am good thanks!

into

Sample generated UML diagram

Requirements

You will need underscore.js and Raphaël

Usage

On your page you need to include both underscore and raphael like so:

<script src="underscore-min.js"></script>
<script src="raphael-min.js"></script>

and then

<div id="diagram">Diagram will be placed here</div>
<script src="sequence-diagram-min.js"></script>
<script> 
  var diagram = Diagram.parse("A->B: Does something");
  diagram.drawSVG('diagram');
</script>

or use jQuery to do all the work:

<div class="diagram">A->B: Message</div>;
<script>;
$(".diagram").sequenceDiagram({theme: 'hand'});
</script>;

Build requirements

# JavaScript Preprocessor 
gem install jspp

## UglifyJS 2
npm install uglify-js -g

## Jison
npm install jison -g

## Then to build, just run:
make

TODO

  • Change Makefile to Grunt (because it looks cool)
  • Other themes
  • Rethink the use of Raphael. Due to its support of VML (which I don't care about), it makes many things harder. For example, font support, css styling, etc. Perhaps draw the SVG by hand, or find a small helper library

Contributors

via GitHub

Thanks

This project makes use of Jison, Raphaël, underscore.js, and the Daniel font (which is free to use for any purpose).

Licence (Simplified BSD License)

Copyright (c) 2012, Andrew Brampton
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Something went wrong with that request. Please try again.