Skip to content

CodeMermaid 流程图

CodeMermaid 是一个基于 Mermaid 的流程图渲染组件,支持动态渲染 Mermaid 图表。

基础用法

使用 content 属性传入 Mermaid 语法字符串。

插槽-自定义工具栏

支持插槽定义,自定义工具栏后,工具栏主题需要自己做主题色适配 工具栏有两种

  1. 鼠标悬浮工具栏
  2. 全屏之后的工具栏

WARNING

thememermaidConfig 单独配置的时候所有组件要配置一样的。因为Mermaid是全局统一渲染的配置,不能单独在渲染的时候配置自己的内容,否则会导致渲染配置不同的情况。除非你是异步渲染,tab切换的类型可以更改。

props

属性名类型必填默认值描述
contentstringMermaid 语法内容
disabledZoomstring[]wheel: 禁止滚轮缩放
fullscreenWheel: 全屏状态下禁止滚轮缩放
clickMove: 禁止点击拖拽缩放
fullscreenClickMove: 全屏状态下禁止点击拖拽缩放
all: 全部禁止
themestringbaseMermaid 主题,支持 default, forest, dark, neutral, base
fullscreenModestringpage全屏模式,支持 web (网页全屏) 和 page (页面全屏)
mermaidConfigMermaidConfig{}Mermaid 配置对象,详见 Mermaid Config

slot

插槽名说明插槽参数
fullscreen-toolbar全屏工具栏isCodeView: 当前显示代码(true)、mermaid图表(false)
isCopied: 表示已经复制,避免它连续复制会有1s的间隔时间让他复制下一次
onCopy: 复制代码函数
toggleView: 切换为code、mermaid图表
zoomIn: 放大
zoomOut: 缩小
resetZoom: 恢复默认
toggleFullscreen: 切换全屏
downloadPng: 下载图片
toolbar普通工具栏参数同上

ref

方法名说明参数
toggleView切换代码/图表视图-
zoomIn放大-
zoomOut缩小-
resetZoom重置缩放-
toggleFullscreen切换全屏-
downloadPng下载 PNG 图片-
onCopy复制代码-