GitHub/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-01-28 07:03:17 +08:00
Code Issues Projects Releases Wiki Activity

Merge pull request #1585 from GDFaber/feature/1460_add_link_target_to_flowchart_click

Browse Source 
Add link target option to flowchart click
This commit is contained in:
Knut Sveidqvist 2020-07-29 15:13:35 +02:00 committed by GitHub
commit d215d31349
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 85 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
cypress/integration/rendering/flowchart.spec.js
View File

@ -529,17 +529,19 @@ describe('Flowchart', () => {
imgSnapshotTest( imgSnapshotTest(
`graph TB `graph TB
TITLE["Link Click Events<br>(click the nodes below)"] TITLE["Link Click Events<br>(click the nodes below)"]
A[link test] A["link test (open in same tab)"]
B[anchor test] B["link test (open in new tab)"]
C[mailto test] C[anchor test]
D[other protocol test] D[mailto test]
E[script test] E[other protocol test]
TITLE --> A & B & C & D & E F[script test]
click A "https://mermaid-js.github.io/mermaid/#/" "link test" TITLE --> A & B & C & D & E & F
click B "#link-clicked" "anchor test" click A "https://mermaid-js.github.io/mermaid/#/" "link test (open in same tab)"
click C "mailto:user@user.user" "mailto test" click B "https://mermaid-js.github.io/mermaid/#/" "link test (open in new tab)" _blank
click D "notes://do-your-thing/id" "other protocol test" click C "#link-clicked"
click E "javascript:alert('test')" "script test" click D "mailto:user@user.user" "mailto test"
click E "notes://do-your-thing/id" "other protocol test"
click F "javascript:alert('test')" "script test"
`, `,
{ securityLevel: 'loose' } { securityLevel: 'loose' }
); );

24
dist/index.html vendored
View File

@ -393,17 +393,19 @@ graph TB
<div class="mermaid"> <div class="mermaid">
graph TB graph TB
TITLE["Link Click Events<br>(click the nodes below)"] TITLE["Link Click Events<br>(click the nodes below)"]
A[link test] A["link test (open in same tab)"]
B[anchor test] B["link test (open in new tab)"]
C[mailto test] C[anchor test]
D[other protocol test] D[mailto test]
E[script test] E[other protocol test]
TITLE --> A & B & C & D & E F[script test]
click A "https://mermaid-js.github.io/mermaid/#/" "link test" TITLE --> A & B & C & D & E & F
click B "#link-clicked" "anchor test" click A "https://mermaid-js.github.io/mermaid/#/" "link test (open in same tab)"
click C "mailto:user@user.user" "mailto test" click B "https://mermaid-js.github.io/mermaid/#/" "link test (open in new tab)" _blank
click D "notes://do-your-thing/id" "other protocol test" click C "#link-clicked"
click E "javascript:alert('test')" "script test" click D "mailto:user@user.user" "mailto test"
click E "notes://do-your-thing/id" "other protocol test"
click F "javascript:alert('test')" "script test"
</div> </div>
<hr/> <hr/>
<div class="mermaid"> <div class="mermaid">

17
docs/flowchart.md
View File

@ -562,6 +562,23 @@ graph LR
?> Due to limitations with how Docsify handles JavaScript callback functions, an alternate working demo for the above code can be viewed at [this jsfiddle](https://jsfiddle.net/s37cjoau/3/). ?> Due to limitations with how Docsify handles JavaScript callback functions, an alternate working demo for the above code can be viewed at [this jsfiddle](https://jsfiddle.net/s37cjoau/3/).
Links are opened in the same browser tab/window by default. It is possible to change this by adding a link target to the click definition (`_self`, `_blank`, `_parent` and `_top` are supported):
```
graph LR;
A-->B;
B-->C;
click A "http://www.github.com" _blank
click B "http://www.github.com" "Open this in a new tab" _blank
```
```mermaid
graph LR;
A-->B;
B-->C;
click A "http://www.github.com" _blank
click B "http://www.github.com" "Open this in a new tab" _blank
```
Beginners tip, a full example using interactive links in a html context: Beginners tip, a full example using interactive links in a html context:
``` ```
<body> <body>

3
src/diagrams/flowchart/flowDb.js
View File

@ -252,12 +252,13 @@ const setClickFun = function(_id, functionName) {
* @param linkStr URL to create a link for * @param linkStr URL to create a link for
* @param tooltip Tooltip for the clickable element * @param tooltip Tooltip for the clickable element
*/ */
export const setLink = function(ids, linkStr, tooltip) { export const setLink = function(ids, linkStr, tooltip, target) {
ids.split(',').forEach(function(_id) { ids.split(',').forEach(function(_id) {
let id = _id; let id = _id;
if (_id[0].match(/\d/)) id = MERMAID_DOM_ID_PREFIX + id; if (_id[0].match(/\d/)) id = MERMAID_DOM_ID_PREFIX + id;
if (typeof vertices[id] !== 'undefined') { if (typeof vertices[id] !== 'undefined') {
vertices[id].link = utils.formatUrl(linkStr, config); vertices[id].link = utils.formatUrl(linkStr, config);
vertices[id].linkTarget = target;
} }
}); });
setTooltip(ids, tooltip); setTooltip(ids, tooltip);

3
src/diagrams/flowchart/flowRenderer-v2.js
View File

@ -486,6 +486,9 @@ export const draw = function(text, id) {
link.setAttributeNS('http://www.w3.org/2000/svg', 'class', vertex.classes.join(' ')); link.setAttributeNS('http://www.w3.org/2000/svg', 'class', vertex.classes.join(' '));
link.setAttributeNS('http://www.w3.org/2000/svg', 'href', vertex.link); link.setAttributeNS('http://www.w3.org/2000/svg', 'href', vertex.link);
link.setAttributeNS('http://www.w3.org/2000/svg', 'rel', 'noopener'); link.setAttributeNS('http://www.w3.org/2000/svg', 'rel', 'noopener');
if (vertex.linkTarget) {
link.setAttributeNS('http://www.w3.org/2000/svg', 'target', vertex.linkTarget);
}
const linkNode = node.insert(function() { const linkNode = node.insert(function() {
return link; return link;

3
src/diagrams/flowchart/flowRenderer.js
View File

@ -469,6 +469,9 @@ export const draw = function(text, id) {
link.setAttributeNS('http://www.w3.org/2000/svg', 'class', vertex.classes.join(' ')); link.setAttributeNS('http://www.w3.org/2000/svg', 'class', vertex.classes.join(' '));
link.setAttributeNS('http://www.w3.org/2000/svg', 'href', vertex.link); link.setAttributeNS('http://www.w3.org/2000/svg', 'href', vertex.link);
link.setAttributeNS('http://www.w3.org/2000/svg', 'rel', 'noopener'); link.setAttributeNS('http://www.w3.org/2000/svg', 'rel', 'noopener');
if (vertex.linkTarget) {
link.setAttributeNS('http://www.w3.org/2000/svg', 'target', vertex.linkTarget);
}
const linkNode = node.insert(function() { const linkNode = node.insert(function() {
return link; return link;

24
src/diagrams/flowchart/parser/flow-interactions.spec.js
View File

@ -39,7 +39,7 @@ describe('[Interactions] when parsing', () => {
const vert = flow.parser.yy.getVertices(); const vert = flow.parser.yy.getVertices();
const edges = flow.parser.yy.getEdges(); const edges = flow.parser.yy.getEdges();
expect(flowDb.setLink).toHaveBeenCalledWith('A', 'click.html', undefined); expect(flowDb.setLink).toHaveBeenCalledWith('A', 'click.html', undefined, undefined);
}); });
it('should handle interaction - click to a link with tooltip', function() { it('should handle interaction - click to a link with tooltip', function() {
@ -49,6 +49,26 @@ describe('[Interactions] when parsing', () => {
const vert = flow.parser.yy.getVertices(); const vert = flow.parser.yy.getVertices();
const edges = flow.parser.yy.getEdges(); const edges = flow.parser.yy.getEdges();
expect(flowDb.setLink).toHaveBeenCalledWith('A', 'click.html', 'tooltip'); expect(flowDb.setLink).toHaveBeenCalledWith('A', 'click.html', 'tooltip', undefined);
});
it('should handle interaction - click to a link with target', function() {
spyOn(flowDb, 'setLink');
const res = flow.parser.parse('graph TD\nA-->B\nclick A "click.html" _blank');
const vert = flow.parser.yy.getVertices();
const edges = flow.parser.yy.getEdges();
expect(flowDb.setLink).toHaveBeenCalledWith('A', 'click.html', undefined, '_blank');
});
it('should handle interaction - click to a link with tooltip and target', function() {
spyOn(flowDb, 'setLink');
const res = flow.parser.parse('graph TD\nA-->B\nclick A "click.html" "tooltip" _blank');
const vert = flow.parser.yy.getVertices();
const edges = flow.parser.yy.getEdges();
expect(flowDb.setLink).toHaveBeenCalledWith('A', 'click.html', 'tooltip', '_blank');
}); });
}); });

12
src/diagrams/flowchart/parser/flow.jison
View File

@ -36,6 +36,12 @@
"flowchart" {if(yy.lex.firstGraph()){this.begin("dir");} return 'GRAPH';} "flowchart" {if(yy.lex.firstGraph()){this.begin("dir");} return 'GRAPH';}
"subgraph" return 'subgraph'; "subgraph" return 'subgraph';
"end"\b\s* return 'end'; "end"\b\s* return 'end';
"_self" return 'LINK_TARGET';
"_blank" return 'LINK_TARGET';
"_parent" return 'LINK_TARGET';
"_top" return 'LINK_TARGET';
<dir>(\r?\n)*\s*\n { this.popState(); return 'NODIR'; } <dir>(\r?\n)*\s*\n { this.popState(); return 'NODIR'; }
<dir>\s*"LR" { this.popState(); return 'DIR'; } <dir>\s*"LR" { this.popState(); return 'DIR'; }
<dir>\s*"RL" { this.popState(); return 'DIR'; } <dir>\s*"RL" { this.popState(); return 'DIR'; }
@ -441,8 +447,10 @@ classStatement:CLASS SPACE alphaNum SPACE alphaNum
clickStatement clickStatement
: CLICK SPACE alphaNum SPACE alphaNum {$$ = $1;yy.setClickEvent($3, $5, undefined);} : CLICK SPACE alphaNum SPACE alphaNum {$$ = $1;yy.setClickEvent($3, $5, undefined);}
| CLICK SPACE alphaNum SPACE alphaNum SPACE STR {$$ = $1;yy.setClickEvent($3, $5, $7) ;} | CLICK SPACE alphaNum SPACE alphaNum SPACE STR {$$ = $1;yy.setClickEvent($3, $5, $7) ;}
| CLICK SPACE alphaNum SPACE STR {$$ = $1;yy.setLink($3, $5, undefined);} | CLICK SPACE alphaNum SPACE STR {$$ = $1;yy.setLink($3, $5, undefined, undefined);}
| CLICK SPACE alphaNum SPACE STR SPACE STR {$$ = $1;yy.setLink($3, $5, $7 );} | CLICK SPACE alphaNum SPACE STR SPACE STR {$$ = $1;yy.setLink($3, $5, $7, undefined );}
| CLICK SPACE alphaNum SPACE STR SPACE LINK_TARGET {$$ = $1;yy.setLink($3, $5, undefined, $7 );}
| CLICK SPACE alphaNum SPACE STR SPACE STR SPACE LINK_TARGET {$$ = $1;yy.setLink($3, $5, $7, $9 );}
; ;
styleStatement:STYLE SPACE alphaNum SPACE stylesOpt styleStatement:STYLE SPACE alphaNum SPACE stylesOpt