- Exciting release!Introducing "safe npm". Learn more →
vue-mermaid
Advanced tools
- Version published
- Maintainers
- 1
- Weekly downloads
- 544
- decreased by-12.12%
Weekly downloads
Readme
vue-mermaid
flowchart of mermaid with vue componet
Requirements
Install Setup
# install dependencies
npm install --save vue-mermaid
Usage
Register component
import VueMermaid from "vue-mermaid";
Vue.use(VueMermaid);
Use component
export default {
data: function() {
return {
data: [
{
id: "1",
text: "A",
link: "---",
next: ["2"],
editable: true,
style: "fill:#f9f,stroke:#333,stroke-width:4px",
},
{ id: "2", text: "B", edgeType: "circle", next: ["3"] },
{ id: "3", text: "C", next: ["4", "6"] },
{ id: "4", text: "D", link: "-- This is the text ---", next: ["5"] },
{ id: "5", text: "E" },
{ id: "6", text: "F" }
]
};
},
methods: {
editNode(nodeId) {
alert(nodeId);
}
}
};
Different link values of next:
nodes: [
{
id: "1",
text: "A",
link: ["-- yes -->", "-- no -->"],
linkNumber: 1,
linkStyle: "fill:none,stroke:red,stroke-width:1px;",
next: ["2", "3"],
editable: true
},
{ id: "2", text: "B" },
{ id: "3", text: "C"}
],
Possible edgeType values:
Template
<template>
<vue-mermaid
:nodes="data"
type="graph LR"
@nodeClick="editNode"
></vue-mermaid>
</template>
Result
Group Type
export default {
data: function() {
return {
data: [
{
id: "1",
text: "A",
link: "---",
next: ["2"],
group: "one"
},
{ id: "2", text: "B", edgeType: "circle", next: ["3"], group: "one" },
{ id: "3", text: "C", next: ["4", "6"], group: "two" },
{
id: "4",
text: "D",
link: "-- This is the text ---",
next: ["5"],
group: "two"
},
{ id: "5", text: "E", group: "three" },
{ id: "6", text: "F", group: "three", , url: "http://www.github.com" }
]
};
}
};
Theme
- To change theme, you can pass in a config object, for available themes, you can refer to mermaidjs themes
<template>
<vue-mermaid
type="graph LR"
:config="config"
></vue-mermaid>
</template>
export default {
data: function() {
return {
config: {
theme: 'neutral'
}
};
}
};
Build Setup
# install dependencies
npm install
# build for production with minification
npm run build
FAQs
flowchart of mermaid with vue componet
The npm package vue-mermaid receives a total of 431 weekly downloads. As such, vue-mermaid popularity was classified as not popular.
We found that vue-mermaid demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Last updated on 11 Apr 2021
Did you know?
Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.