GitHub/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-02-04 07:13:25 +08:00
Code Issues Projects Releases Wiki Activity

#5237 Removed node properties, doc status in types

Browse Source
This commit is contained in:
Knut Sveidqvist 2024-05-20 14:33:54 +02:00
parent c8f2abad18
commit 0d2c7c3b2c
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
packages/mermaid/src/rendering-util/types.d.ts vendored
View File

@ -14,17 +14,19 @@ interface Node {
id: string; id: string;
label?: string; label?: string;
parentId?: string; parentId?: string;
position?: string; // Keep, this is for notes 'left of', 'right of', etc. position?: string; // Keep, this is for notes 'left of', 'right of', etc. Move into nodeNode
cssStyles?: string; // Renamed from `styles` to `cssStyles` cssStyles?: string; // Renamed from `styles` to `cssStyles`
cssClasses?: string; // Renamed from `classes` to `cssClasses` cssClasses?: string; // Renamed from `classes` to `cssClasses`
// style?: string; //REMOVE // style?: string; //REMOVE ✅
// class?: string; //REMOVE // class?: string; //REMOVE ✅
// labelText?: string; //REMOVE, use `label` instead // labelText?: string; //REMOVE, use `label` instead ✅
// props?: Record<string, unknown>; //REMOVE // props?: Record<string, unknown>; //REMOVE ✅
// type: string; // REMOVE, replace with isGroup: boolean, default false ✅
// borders?: string; //REMOVE ✅
labelStyle?: string; labelStyle?: string;
// Flowchart specific properties // Flowchart specific properties
labelType?: string; // REMOVE? Always use markdown string, need to check for KaTeX - wait with this one labelType?: string; // REMOVE? Always use markdown string, need to check for KaTeX - ⏳ wait with this one
domId: string; domId: string;
// Rendering specific properties for both Flowchart and State Diagram nodes // Rendering specific properties for both Flowchart and State Diagram nodes
dir?: string; // Only relevant for isGroup true, i.e. a sub-graph or composite state. dir?: string; // Only relevant for isGroup true, i.e. a sub-graph or composite state.
@ -34,7 +36,6 @@ interface Node {
padding?: number; //REMOVE?, use from LayoutData.config - Keep, this could be shape specific padding?: number; //REMOVE?, use from LayoutData.config - Keep, this could be shape specific
shape?: string; shape?: string;
tooltip?: string; tooltip?: string;
type: string; // REMOVE, replace with isGroup: boolean, default false
isGroup: boolean; isGroup: boolean;
width?: number; width?: number;
height?: number; height?: number;
@ -45,7 +46,6 @@ interface Node {
rx?: number; // Used for rounded corners in Rect, Ellipse, etc.Maybe it to specialized RectNode, EllipseNode, etc. rx?: number; // Used for rounded corners in Rect, Ellipse, etc.Maybe it to specialized RectNode, EllipseNode, etc.
ry?: number; ry?: number;
borders?: string; //REMOVE
useRough?: boolean; useRough?: boolean;
useHtmlLabels?: boolean; useHtmlLabels?: boolean;
centerLabel?: boolean; //keep for now. centerLabel?: boolean; //keep for now.