Skip to content

Latest commit

 

History

History
148 lines (110 loc) · 4.81 KB

README.md

File metadata and controls

148 lines (110 loc) · 4.81 KB
Raw

JS Sequence Diagrams

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

by Andrew Brampton 2012-2013

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>;

Extended example

we turn

Title: Sample Diagram[fontcolor="white", fillcolor="blue", color="red"]
Participant Alice as A [color="red"]
Participant Bob [fillcolor="blue", fontcolor="white"]
A->Bob: Message [color="gray"]
Note left of A: Hello color\nNotes [URL="http://example.com", fillcolor="orange"]
Note right of Bob: Click Me\nI will take you\nto example.com [URL="http://example.com"]
Note over A, Bob: Gradient colors [fillcolor="90-#f00:5-#00f:95"]

into

Sample generated UML diagram

Attributes

We support subset of Graphviz attributes

Attribute Description
color Basic drawing color for graphics, not text.
fillcolor Color used to fill the background of a node.
fontcolor Color used for text.
URL Hyperlinks incorporated into device-dependent output.
href Same as URL

Build requirements

# JavaScript Preprocessor 
sudo gem install jspp

## UglifyJS 2
sudo npm install uglify-js -g

## Jison
sudo npm install jison -g

## JSHint (for linting)
sudo npm install jshint -g

## Then to build, just run:
make

How to release

  • Make sure all changes checked in
  • Bump version in src/copyright.js
  • make clean
  • make
  • git add src/copyright.js build/sequence-diagram-min.js build/sequence-diagram-min.js.map
  • git commit
  • git push origin master
  • git tag -a v1.x.x -m v1.x.x
  • git push origin v1.x.x

TODO

  • 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).

Many thanks to Web Sequence Diagrams which greatly inspired this project, and forms the basis for the syntax.

Related

Licence (Simplified BSD License)

Copyright (c) 2012-2013, 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.