marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-14 12:59:46 +02:00
Code Issues Packages Projects Releases Wiki Activity

#1295 Adding support for multiline descriptions for states

Browse Source
This commit is contained in:
Knut Sveidqvist
2020-04-26 09:47:47 +02:00
parent 0aede618ec
commit 5662c06a33
3 changed files with 26 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
cypress/platform/current.html
View File

@@ -50,9 +50,13 @@
</div> </div>
<div class="mermaid" style="width: 50%; height: 20%;"> <div class="mermaid" style="width: 50%; height: 20%;">
stateDiagram-v2 stateDiagram-v2
State1: This a a single line description
[*] --> S1 State2: This a a multi line description
state "Some long name" as S1: The description<br/>continues State2: here comes the multi part
a
[*] --> State1
State1 --> State2
State2 --> [*]
</div> </div>
<div class="mermaid2 mermaid-apa" style="width: 100%; height: 20%;"> <div class="mermaid2 mermaid-apa" style="width: 100%; height: 20%;">
stateDiagram stateDiagram

1
src/diagrams/state/stateDb.js
View File

@@ -132,6 +132,7 @@ export const addState = function(id, type, doc, descr, note) {
} }
} }
if (descr) { if (descr) {
logger.info('Adding state ', id, descr);
if (typeof descr === 'string') addDescription(id, descr.trim()); if (typeof descr === 'string') addDescription(id, descr.trim());
if (typeof descr === 'object') { if (typeof descr === 'object') {

19
src/diagrams/state/stateRenderer-v2.js
View File

@@ -52,15 +52,28 @@ const setupNode = (g, parent, node, altFlag) => {
}; };
} }
// Description // Build of the array of description strings accordinging
if (node.description) { if (node.description) {
if (Array.isArray(node.description)) { if (Array.isArray(nodeDb[node.id].description)) {
// There already is an array of strings,add to it
nodeDb[node.id].shape = 'rectWithTitle'; nodeDb[node.id].shape = 'rectWithTitle';
nodeDb[node.id].description = node.description; nodeDb[node.id].description.push(node.description);
} else { } else {
if (nodeDb[node.id].description.length > 0) {
// if there is a description already transformit to an array
nodeDb[node.id].shape = 'rectWithTitle';
if (nodeDb[node.id].description === node.id) {
// If the previous description was the is, remove it
nodeDb[node.id].description = [node.description];
} else {
nodeDb[node.id].description = [nodeDb[node.id].description, node.description];
}
} else {
nodeDb[node.id].shape = 'rect';
nodeDb[node.id].description = node.description; nodeDb[node.id].description = node.description;
} }
} }
}
// Save data for description and group so that for instance a statement without description overwrites // Save data for description and group so that for instance a statement without description overwrites
// one with description // one with description