Update class diagram to v3 using new renderer #5880
Conversation
|
✅ Deploy Preview for mermaid-js ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
commit: |
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
| @@ -91,6 +99,16 @@ export const addClass = function (_id: string) { | |||
| classCounter++; | |||
| }; | |||
|
|
|||
| const addInterface = function (label: string, classId: string) { | |||
| const _interface: Interface = { | |||
There was a problem hiding this comment.
This is just personal preference/nit, but Im not a fan of prefacing variables names with _
| ]; | ||
|
|
||
| if ( | ||
| relation.relation.type1 === relationType.LOLLIPOP && |
There was a problem hiding this comment.
nit: maybe change relation variable to classRelation. Only because it looks odd to say relation.relation.
| styleClasses.set(id, styleClass); | ||
| } | ||
|
|
||
| if (style !== undefined && style !== null) { |
There was a problem hiding this comment.
nit: you should be able to just say if (style) {..}
| }); | ||
| } | ||
|
|
||
| for (const [, value] of classes) { |
There was a problem hiding this comment.
I know that the syntax is so that you can basically just "ignore" the key section of the KVP, but it always looks so weird to me
| } | ||
|
|
||
| for (const [, value] of classes) { | ||
| if (value.cssClasses.includes(id)) { |
There was a problem hiding this comment.
Try and minimize nested loops where possible.
if (value.cssClasses.includes(id)) {
value.styles.push(...style.flatMap(s => s.split(',')));
}
📑 Summary
Updates the class diagram to the new unified way of rendering. Includes a new "classBox" shape to be used in diagrams as well as some other updates such as: the option to hide the empty members box in class diagrams, support for handDrawn look, the introduction of the classDef statement into class diagrams, support for styling the default class, and lollipop interfaces.
Includes fixes / additions for #5562 #3139 and #4037
📏 Design Decisions
📋 Tasks
Make sure you
MERMAID_RELEASE_VERSIONis used for all new features.pnpm changesetand following the prompts. Changesets that add features should beminorand those that fix bugs should bepatch. Please prefix changeset messages withfeat:,fix:, orchore:.