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

Update documentation

Browse Source
This commit is contained in:
Matthieu MOREL 2020-12-06 22:48:01 +01:00
parent 619b9f230f
commit 7f22d155f2
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/classDiagram.md
View File

@ -450,13 +450,13 @@ It is possible to bind a click event to a node, the click can lead to either a j
You would define these actions on a separate line after all classes have been declared.
```
action className "reference" "tooltip"
click className call callback() "tooltip"
click className href "url" "tooltip"
```
- _action_ is either `link` or `callback`, depending on which type of interaction you want to have called
- _className_ is the id of the node that the action will be associated with
- _reference_ is either the url link, or the function name for callback. (note: callback function will be called with the nodeId as parameter).
- (_optional_) tooltip is a string to be displayed when hovering over element (note: The styles of the tooltip are set by the class .mermaidTooltip.)
- note: callback function will be called with the nodeId as parameter.
### Examples
@ -465,7 +465,7 @@ _URL Link:_
```
classDiagram
class Shape
link Shape "http://www.github.com" "This is a tooltip for a link"
click Shape href "http://www.github.com" "This is a tooltip for a link"
```
_Callback:_
@ -473,7 +473,7 @@ _Callback:_
```
classDiagram
class Shape
callback Shape "callbackFunction" "This is a tooltip for a callback"
click Shape call callbackFunction() "This is a tooltip for a callback"
```
```
@ -488,8 +488,8 @@ callback Shape "callbackFunction" "This is a tooltip for a callback"
classDiagram
class Class01
class Class02
callback Class01 "callbackFunction" "Callback tooltip"
link Class02 "http://www.github.com" "This is a link"
click Class01 call callbackFunction() "Callback tooltip"
click Class02 href "http://www.github.com" "This is a link"
```
> **Success** The tooltip functionality and the ability to link to urls are available from version 0.5.2.
@ -521,8 +521,8 @@ Beginners tip, a full example using interactive links in an html context:
+run()
}
callback Duck callback "Tooltip"
click Zebra "http://www.github.com" "This is a link"
click Duck call callback() "Tooltip"
click Zebra href "http://www.github.com" "This is a link"
</div>
<script>