diff --git a/cypress/platform/current.html b/cypress/platform/current.html index 6bcf91507..7bfa3ab8d 100644 --- a/cypress/platform/current.html +++ b/cypress/platform/current.html @@ -40,22 +40,15 @@ G-->c
-stateDiagram-v2 - [*] --> First +flowchart LR + A{{A}}-->B{{B}}; + click A callback "Tooltip" + click B "http://www.github.com" "This is a link" - state First { - [*] --> Second - - state Second { - [*] --> second - second --> Third - - state Third { - [*] --> third - third --> [*] - } - } - } +
+
+flowchart LR + A{{A}}-->B{{B}};
@@ -277,8 +270,9 @@ stateDiagram-v2 // sequenceDiagram: { actorMargin: 300 } // deprecated fontFamily: '"arial", sans-serif', curve: 'linear', + securityLevel: 'loose' }); - + function callback(){alert('It worked');} diff --git a/docs/flowchart.md b/docs/flowchart.md index 1e3d00510..40d8b2ec3 100644 --- a/docs/flowchart.md +++ b/docs/flowchart.md @@ -35,6 +35,9 @@ Possible directions are: * TD - same as TB +## flowchart + +This renders a flowchart in the same way as graph but with a new rendering method opening up for long requested features as more arrow types, multi directional arrows and link to and from subgraphs. Apart from the graph type flowchart/graph the syntax is the same. This is currently experimental but when the beta persioid is over both the graph and flowchart keyswords will render in the new way. This means it is ok to start betat testing flowcharts. ## Nodes & shapes @@ -62,7 +65,7 @@ graph LR id1[This is the text in the box] ``` ```mermaid -graph LR +flowchart LR id1[This is the text in the box] ``` @@ -70,66 +73,66 @@ graph LR ### A node with round edges ``` -graph LR +flowchart LR id1(This is the text in the box) ``` ```mermaid -graph LR +flowchart LR id1(This is the text in the box) ``` ### A stadium-shaped node ``` -graph LR +flowchart LR id1([This is the text in the box]) ``` ```mermaid -graph LR +flowchart LR id1([This is the text in the box]) ``` ### A node in a subroutine shape ``` -graph LR +flowchart LR id1[[This is the text in the box]] ``` ```mermaid -graph LR +flowchart LR id1[[This is the text in the box]] ``` ### A node in a cylindrical shape ``` -graph LR +flowchart LR id1[(Database)] ``` ```mermaid -graph LR +flowchart LR id1[(Database)] ``` ### A node in the form of a circle ``` -graph LR +flowchart LR id1((This is the text in the circle)) ``` ```mermaid -graph LR +flowchart LR id1((This is the text in the circle)) ``` ### A node in an asymetric shape ``` -graph LR +flowchart LR id1>This is the text in the box] ``` ```mermaid -graph LR +flowchart LR id1>This is the text in the box] ``` Currently only the shape above is possible and not its mirror. *This might change with future releases.* @@ -137,22 +140,22 @@ Currently only the shape above is possible and not its mirror. *This might chang ### A node (rhombus) ``` -graph LR +flowchart LR id1{This is the text in the box} ``` ```mermaid -graph LR +flowchart LR id1{This is the text in the box} ``` ### A hexagon node ``` -graph LR +flowchart LR id1{{This is the text in the box}} ``` ```mermaid -graph LR +flowchart LR id1{{This is the text in the box}} ``` @@ -206,22 +209,22 @@ Nodes can be connected with links/edges. It is possible to have different types ### A link with arrow head ``` -graph LR +flowchart LR A-->B ``` ```mermaid -graph LR +flowchart LR A-->B ``` ### An open link ``` -graph LR +flowchart LR A --- B ``` ```mermaid -graph LR +flowchart LR A --- B ``` @@ -229,87 +232,87 @@ graph LR ``` graph LR - A-- This is the text ---B + A-- This is the text! ---B ``` ```mermaid -graph LR +flowchart LR A-- This is the text ---B ``` or ``` -graph LR +flowchart LR A---|This is the text|B ``` ```mermaid -graph LR +flowchart LR A---|This is the text|B ``` ### A link with arrow head and text ``` -graph LR +flowchart LR A-->|text|B ``` ```mermaid -graph LR +flowchart LR A-->|text|B ``` or ``` -graph LR +flowchart LR A-- text -->B ``` ```mermaid -graph LR +flowchart LR A-- text -->B ``` ### Dotted link ``` -graph LR; +flowchart LR; A-.->B; ``` ```mermaid -graph LR; +flowchart LR; A-.->B; ``` ### Dotted link with text ``` -graph LR +flowchart LR A-. text .-> B ``` ```mermaid -graph LR +flowchart LR A-. text .-> B ``` ### Thick link ``` -graph LR +flowchart LR A ==> B ``` ```mermaid -graph LR +flowchart LR A ==> B ``` ### Thick link with text ``` -graph LR +flowchart LR A == text ==> B ``` ```mermaid -graph LR +flowchart LR A == text ==> B ``` @@ -317,21 +320,21 @@ graph LR It is possible declare many links in the same line as per below: ``` -graph LR +flowchart LR A -- text --> B -- text2 --> C ``` ```mermaid -graph LR +flowchart LR A -- text --> B -- text2 --> C ``` It is also possible to declare multiple nodes links in the same line as per below: ``` -graph LR +flowchart LR a --> b & c--> d ``` ```mermaid -graph LR +flowchart LR a --> b & c--> d ``` @@ -356,17 +359,51 @@ graph TB B --> D ``` +## Beta: New arrow types + +When using flowchart instead of graph there is the are new types of arrows supported as per below: + +``` +flowchart LR + A --o B + B --x C +``` + +```mermaid +flowchart LR + A --o B + B --x C +``` + + +## Beta: multi directional arrows + +When using flowchart instead of graph there is the possibility to use multidirectional arrows. + +``` +flowchart LR + A o--o B + B <--> C + C x--x D +``` + +```mermaid +flowchart LR + A o--o B + B <--> C + C x--x D +``` ## Special characters that break syntax It is possible to put text within quotes in order to render more troublesome characters. As in the example below: ``` -graph LR +flowchart LR id1["This is the (text) in the box"] ``` ```mermaid -graph LR +flowchart LR id1["This is the (text) in the box"] ``` @@ -375,11 +412,11 @@ graph LR It is possible to escape characters using the syntax examplified here. ``` - graph LR + flowchart LR A["A double quote:#quot;"] -->B["A dec char:#9829;"] ``` ```mermaid - graph LR + flowchart LR A["A double quote:#quot;"] -->B["A dec char:#9829;"] ``` @@ -437,6 +474,44 @@ graph TB end ``` +## Beta: flowcharts + +With the graphtype flowcharts it is also possible to set edges to and from subgraphs as in the graph below. + +``` +flowchart TB + c1-->a2 + subgraph one + a1-->a2 + end + subgraph two + b1-->b2 + end + subgraph three + c1-->c2 + end + one --> two + three --> two + two --> c2 + ``` + +```mermaid +flowchart TB + c1-->a2 + subgraph one + a1-->a2 + end + subgraph two + b1-->b2 + end + subgraph three + c1-->c2 + end + one --> two + three --> two + two --> c2 + ``` + ## Interaction It is possible to bind a click event to a node, the click can lead to either a javascript callback or to a link which will be opened in a new browser tab. **Note**: This functionality is disabled when using `securityLevel='strict'` and enabled when using `securityLevel='loose'`. @@ -459,7 +534,7 @@ Examples of tooltip usage below: ``` ``` -graph LR; +flowchart LR; A-->B; click A callback "Tooltip for a callback" click B "http://www.github.com" "This is a tooltip for a link" @@ -468,7 +543,7 @@ graph LR; The tooltip text is surrounded in double quotes. The styles of the tooltip are set by the class .mermaidTooltip. ```mermaid -graph LR; +graph LR A-->B; click A callback "Tooltip" click B "http://www.github.com" "This is a link" diff --git a/docs/stateDiagram.md b/docs/stateDiagram.md index 446cc281a..c593aa2b8 100755 --- a/docs/stateDiagram.md +++ b/docs/stateDiagram.md @@ -5,7 +5,7 @@ Mermaid can render state diagrams. The syntax tries to be compliant with the syntax used in plantUml as this will make it easier for users to share diagrams between mermaid and plantUml. ```markdown -stateDiagram +stateDiagram-v2 [*] --> Still Still --> [*] @@ -15,6 +15,16 @@ stateDiagram Crash --> [*] ``` +```mermaid +stateDiagram-v2 + [*] --> Still + Still --> [*] + + Still --> Moving + Moving --> Still + Moving --> Crash + Crash --> [*] +``` ```mermaid stateDiagram [*] --> Still @@ -33,36 +43,36 @@ In state diagrams systems are described in terms of its states and how the syste A state can be declared in multiple ways. The simplest way is to define a state id as a description. ```markdown -stateDiagram +stateDiagram-v2 s1 ``` ```mermaid -stateDiagram +stateDiagram-v2 s1 ``` Another way is by using the state keyword with a description as per below: ```markdown -stateDiagram +stateDiagram-v2 state "This is a state description" as s2 ``` ```mermaid -stateDiagram +stateDiagram-v2 state "This is a state description" as s2 ``` Another way to define a state with a description is to define the state id followed by a colon and the description: ```markdown -stateDiagram +stateDiagram-v2 s2 : This is a state description ``` ```mermaid -stateDiagram +stateDiagram-v2 s2 : This is a state description ``` @@ -73,24 +83,24 @@ Transitions are path/edges when one state passes into another. This is represent When you define a transition between two states and the states are not already defined the undefined states are defined with the id from the transition. You can later add descriptions to states defined this way. ```markdown -stateDiagram +stateDiagram-v2 s1 --> s2 ``` ```mermaid -stateDiagram +stateDiagram-v2 s1 --> s2 ``` It is possible to add text to a transition. To describe what it represents. ```markdown -stateDiagram +stateDiagram-v2 s1 --> s2: A transition ``` ```mermaid -stateDiagram +stateDiagram-v2 s1 --> s2: A transition ``` @@ -99,13 +109,13 @@ stateDiagram There are two special states indicating the start and stop of the diagram. These are written with the [\*] syntax and the direction of the transition to it defines it either as a start or a stop state. ```markdown -stateDiagram +stateDiagram-v2 [*] --> s1 s1 --> [*] ``` ```mermaid -stateDiagram +stateDiagram-v2 [*] --> s1 s1 --> [*] ``` @@ -118,7 +128,7 @@ have several internal states. These are called composite states in this terminol In order to define a composite state you need to use the state keyword followed by and id and the body of the composite state between \{\}. See the example below: ```markdown -stateDiagram +stateDiagram-v2 [*] --> First state First { [*] --> second @@ -127,7 +137,7 @@ stateDiagram ``` ```mermaid -stateDiagram +stateDiagram-v2 [*] --> First state First { [*] --> second @@ -138,7 +148,7 @@ stateDiagram You can do this in several layers: ```markdown -stateDiagram +stateDiagram-v2 [*] --> First state First { @@ -157,7 +167,7 @@ stateDiagram ``` ```mermaid -stateDiagram-v2 +stateDiagram-v2-v2 [*] --> First state First { @@ -177,7 +187,7 @@ stateDiagram-v2 You can also define transitions also between composite states: ```markdown -stateDiagram +stateDiagram-v2 [*] --> First First --> Second First --> Third @@ -197,7 +207,7 @@ stateDiagram ``` ```mermaid -stateDiagram +stateDiagram-v2 [*] --> First First --> Second First --> Third @@ -223,7 +233,7 @@ stateDiagram It is possible to specify a fork in the diagram using <<fork>> <<join>>. ```markdown - stateDiagram + stateDiagram-v2 state fork_state <> [*] --> fork_state fork_state --> State2 @@ -237,7 +247,7 @@ It is possible to specify a fork in the diagram using <<fork>> <& ``` ```mermaid - stateDiagram + stateDiagram-v2 state fork_state <> [*] --> fork_state fork_state --> State2 @@ -258,7 +268,7 @@ Sometimes nothing says it better then a Post-it note. That is also the case in s Here you can choose to put the note to the *right of* or to the *left of* a node. ```markdown - stateDiagram + stateDiagram-v2 State1: The state with a note note right of State1 Important information! You can write @@ -269,7 +279,7 @@ Here you can choose to put the note to the *right of* or to the *left of* a node ``` ```mermaid - stateDiagram + stateDiagram-v2 State1: The state with a note note right of State1 Important information! You can write @@ -285,7 +295,7 @@ Here you can choose to put the note to the *right of* or to the *left of* a node As in plantUml you can specify concurrency using the -- symbol. ```markdown - stateDiagram + stateDiagram-v2 [*] --> Active state Active { @@ -304,7 +314,7 @@ As in plantUml you can specify concurrency using the -- symbol. ``` ```mermaid - stateDiagram + stateDiagram-v2 [*] --> Active state Active { @@ -327,7 +337,7 @@ As in plantUml you can specify concurrency using the -- symbol. Comments can be entered within a state diagram chart, which will be ignored by the parser. Comments need to be on their own line, and must be prefaced with `%%` (double percent signs). Any text after the start of the comment to the next newline will be treated as a comment, including any diagram syntax ``` -stateDiagram +stateDiagram-v2 [*] --> Still Still --> [*] %% this is a comment diff --git a/src/dagre-wrapper/edges.js b/src/dagre-wrapper/edges.js index 3be3fafdd..d3db26372 100644 --- a/src/dagre-wrapper/edges.js +++ b/src/dagre-wrapper/edges.js @@ -34,8 +34,10 @@ export const insertEdgeLabel = (elem, edge) => { export const positionEdgeLabel = edge => { logger.info('Moving label', edge.id, edge.label, edgeLabels[edge.id]); - const el = edgeLabels[edge.id]; - el.attr('transform', 'translate(' + edge.x + ', ' + edge.y + ')'); + if (edge.label) { + const el = edgeLabels[edge.id]; + el.attr('transform', 'translate(' + edge.x + ', ' + edge.y + ')'); + } }; // const getRelationType = function(type) { diff --git a/src/dagre-wrapper/nodes.js b/src/dagre-wrapper/nodes.js index 3a1370f3f..c66f02be9 100644 --- a/src/dagre-wrapper/nodes.js +++ b/src/dagre-wrapper/nodes.js @@ -255,7 +255,7 @@ const rect = (parent, node) => { const rect = shapeSvg.insert('rect', ':first-child'); rect - .attr('class', 'basic') + .attr('class', 'basic label-container') .attr('rx', node.rx) .attr('ry', node.ry) .attr('x', -bbox.width / 2 - halfPadding) @@ -384,6 +384,34 @@ const circle = (parent, node) => { return shapeSvg; }; + +const subroutine = (parent, node) => { + const { shapeSvg, bbox } = labelHelper(parent, node); + + const w = bbox.width + node.padding; + const h = bbox.height + node.padding; + const points = [ + { x: 0, y: 0 }, + { x: w, y: 0 }, + { x: w, y: -h }, + { x: 0, y: -h }, + { x: 0, y: 0 }, + { x: -8, y: 0 }, + { x: w + 8, y: 0 }, + { x: w + 8, y: -h }, + { x: -8, y: -h }, + { x: -8, y: 0 } + ]; + const el = insertPolygonShape(shapeSvg, w, h, points); + updateNodeBounds(node, el); + + node.intersect = function(point) { + return intersect.polygon(node, point); + }; + + return shapeSvg; +}; + const start = (parent, node) => { const shapeSvg = parent .insert('g') @@ -487,6 +515,7 @@ const shapes = { start, end, note, + subroutine, fork: forkJoin, join: forkJoin }; diff --git a/src/dagre-wrapper/shapes/util.js b/src/dagre-wrapper/shapes/util.js index 632652e16..cf7ff123f 100644 --- a/src/dagre-wrapper/shapes/util.js +++ b/src/dagre-wrapper/shapes/util.js @@ -46,5 +46,6 @@ export function insertPolygonShape(parent, w, h, points) { }) .join(' ') ) + .attr('class', 'label-container') .attr('transform', 'translate(' + -w / 2 + ',' + h / 2 + ')'); } diff --git a/src/diagrams/flowchart/flowRenderer-v2.js b/src/diagrams/flowchart/flowRenderer-v2.js index c114485c4..237aa2aa7 100644 --- a/src/diagrams/flowchart/flowRenderer-v2.js +++ b/src/diagrams/flowchart/flowRenderer-v2.js @@ -239,7 +239,7 @@ export const addEdges = function(edges, g) { edgeData.arrowheadStyle = 'fill: #333'; edgeData.labelpos = 'c'; - if (getConfig().flowchart.htmlLabels) { + if (getConfig().flowchart.htmlLabels && false) { // eslint-disable-line edgeData.labelType = 'html'; edgeData.label = '' + edge.text + ''; } else { diff --git a/src/diagrams/flowchart/flowRenderer.js b/src/diagrams/flowchart/flowRenderer.js index 2623ba77a..b55d8e350 100644 --- a/src/diagrams/flowchart/flowRenderer.js +++ b/src/diagrams/flowchart/flowRenderer.js @@ -424,7 +424,7 @@ export const draw = function(text, id) { } // Add label rects for non html labels - if (!conf.htmlLabels) { + if (!conf.htmlLabels || true) { // eslint-disable-line const labels = document.querySelectorAll('[id="' + id + '"] .edgeLabel .label'); for (let k = 0; k < labels.length; k++) { const label = labels[k]; diff --git a/src/diagrams/state/stateRenderer-v2.js b/src/diagrams/state/stateRenderer-v2.js index b652e68a4..a5f26bd17 100644 --- a/src/diagrams/state/stateRenderer-v2.js +++ b/src/diagrams/state/stateRenderer-v2.js @@ -286,10 +286,25 @@ export const draw = function(text, id) { svg.attr('width', width * 1.75); svg.attr('class', 'statediagram'); // diagram.attr('height', bounds.height * 3 + conf.padding * 2); - svg.attr( - 'viewBox', - `${bounds.x - conf.padding} ${bounds.y - conf.padding} ` + width + ' ' + height - ); + // svg.attr( + // 'viewBox', + // `${bounds.x - conf.padding} ${bounds.y - conf.padding} ` + width + ' ' + height + // ); + + const svgBounds = svg.node().getBBox(); + + if (conf.useMaxWidth) { + svg.attr('width', '100%'); + svg.attr('style', `max-width: ${width}px;`); + } else { + svg.attr('height', height); + svg.attr('width', width); + } + + // Ensure the viewBox includes the whole svgBounds area with extra space for padding + const vBox = `${svgBounds.x - padding} ${svgBounds.y - padding} ${width} ${height}`; + logger.debug(`viewBox ${vBox}`); + svg.attr('viewBox', vBox); // Add label rects for non html labels if (!conf.htmlLabels) { diff --git a/src/mermaidAPI.js b/src/mermaidAPI.js index 68f6ee165..a18a86d31 100644 --- a/src/mermaidAPI.js +++ b/src/mermaidAPI.js @@ -736,7 +736,7 @@ const render = function(id, _txt, cb, container) { } // classDef - if (graphType === 'flowchart') { + if (graphType === 'flowchart' || graphType === 'flowchart-v2') { const classes = flowRenderer.getClasses(txt); for (const className in classes) { style += `\n.${className} > * { ${classes[className].styles.join( @@ -858,6 +858,7 @@ const render = function(id, _txt, cb, container) { if (typeof cb !== 'undefined') { switch (graphType) { case 'flowchart': + case 'flowchart-v2': cb(svgCode, flowDb.bindFunctions); break; case 'gantt':