Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Streamlining and enhancing diagram rendering across various diagram types #5604

Merged
merged 274 commits into from
Aug 12, 2024
Merged

Streamlining and enhancing diagram rendering across various diagram types #5604

merged 274 commits into from
Aug 12, 2024

Conversation

knsv
Copy link
Collaborator

@knsv knsv commented Jun 28, 2024

📑 Summary

There is noticeable duplication in functionality among different diagram types. Several graph-based diagrams share common features in rendering, but these are implemented separately in each diagram type.

This PR introduces a Unified Layout Engine: Implement a singular layout engine for all graph-based diagrams.

Benefits:

  • Facilitates the introduction of new layout algorithms universally across all graph-based diagrams.
  • Enhances consistency in diagram layouts.
  • Standardizes interaction, styling, and class handling across diagrams.
  • Enables shape reusability between different diagram types.
  • Simplifies introduction of additional layout engines
  • New layout engines will work for all diagrams using this way of rendering

Resolves #5237

📏 Design Decisions

Describe the way your implementation works or what design decisions you made if applicable.

📋 Tasks

Make sure you

ashishjain0512 and others added 30 commits May 3, 2024 12:50
@ashishjain0512
#5237 fix for node duplication
5e53d6c
@ashishjain0512
#5237 pass useRough to edges
024bffd
@knsv
#5237 Recusive structuture refactoring for subgraphs
b2c286f
@knsv
#5237 Support for composit states WIP
853948a
@knsv
#5237 Support for composit states WIP, rough
16cd7bf
@knsv
#5237 Support for composit states WIP, rough
39bffcb
@knsv
#5237 Setting layout algorithm and handrawn or not via configuration
323737f
@knsv
#5237 Adjustment for different sematics between dagre and elk positio…
d497a5c 
…ning
@knsv
#5237 Bugfix for fork/join
b9a73c8
@sidharthv96
Merge branch 'develop' into 5237-unified-layout-common-renderer
7529db8 
* develop: (462 commits)
  Update packages/mermaid/src/diagrams/sequence/parser/sequenceDiagram.jison
  fix: Simplify actor type of activeStart and activeEnd
  chore(deps): update all patch dependencies
  chore: Fix typo
  chore(deps): update all patch dependencies
  chore: remove repetitive words
  Update stateDiagram.md
  Update stateDiagram.md
  fix: simply from and to in message to string type
  docs: Add quadrant point styling
  feat: Change precedence of styling
  chore(deps): update all minor dependencies
  chore(deps): update all patch dependencies
  fix: eslint ignore, type definition
  chore(deps): update all patch dependencies
  fix: Remove `ImperativeState` type restriction.
  📝🐛 fix schema link
  update latest news section
  Changes to rendering/gitGraph.spec.js - Added additional rendering test functionality for recognizing 'switch' as an alias to 'checkout'.
  1. Changes to gitGraph.jison - Updated the regex to allow either 'checkout' or 'switch' 2. Changes to gitGraphParser.spec.js - Additional test coverage added for the changes made to the parser. 3. Changes to gitGraphParserV2.spec.js - Additional test coverafe added for the changes made to the parser. 4. Changes to gitgraph.md - Updated documentation to let users know that checkout/switch can be used interchangeably.
  ...
@ashishjain0512
#5237 fix for duplicate nodes for join fork
fbe13f4
@ashishjain0512
#5237 add support for note shape
683695b
@knsv
#5237 Edge labels for ELK
3ff4a69
@ashishjain0512
#5237 added state refactor test page
7372d90
@knsv
#5237 Edge labels for ELK - mergwe
32a62be
@knsv
Merge branch '5237-unified-layout-common-renderer' of github.com:merm…
94bb439 
…aid-js/mermaid into 5237-unified-layout-common-renderer
@ashishjain0512
#5237 added state refactor test page
f480fb7
@knsv
#5237 Alternating background
7ecb772
@knsv
#5237 Theme support
ce6f273
@knsv
#5237 Rough rendering of notes
4c0b8f6
@ashishjain0512
#5237 pass useRough to note & group nodes
2f80c3a
@knsv
#5237 Updating configuration otions and adding handdrawnSeed
ab07799
@knsv
#5237 Style support in rects
f5fefc0
@knsv
#5237 Fix for arrowheads when usising non linear curves with roughjs
20f9e50
@ashishjain0512
#5237 pass css node style like bgColor, borderColor, borderWeight for…
e8018ed 
… roughjs
@knsv
#5237 Improved Edge Handling
42a12a6
@knsv
#5237 Theme support for stateStart, stateEnd, choice and fork/join
55afd8c
@sidharthv96
chore: Move layout-elk to different package
64f1d2f
@sidharthv96
chore: Update imports in layout-elk
745ec0d
@sidharthv96
Merge branch '5237-unified-layout-common-renderer' of https://github.…
b1b27f7 
…com/mermaid-js/mermaid into 5237-unified-layout-common-renderer

* '5237-unified-layout-common-renderer' of https://github.com/mermaid-js/mermaid:
  #5237 Theme support for stateStart, stateEnd, choice and fork/join
  #5237 Improved Edge Handling
  #5237 pass css node style like bgColor, borderColor, borderWeight for roughjs
@sidharthv96
Copy link
Member

Please check and merge #5670

knsv and others added 23 commits July 31, 2024 15:03
@knsv
5237 Fix for edges to diamond shapes
c4ce854
@knsv
#5237 Fix for issue with styling rectWithTitle
aa24229
@knsv
#5237 Fix for issue with edge routing for elk layout
61cc2fc
@knsv
Adding elk test
c2a479a
@knsv
#5237 Fixes from comments
729080f
@knsv
#5237 Removing old flowchart renderer
ba0d216
@knsv
#5237 Replace generic object with Map
537512f
@ashishjain0512
review comment fixes
d4d7ca7
@ashishjain0512
merge commit
95fb824
@ashishjain0512
sequence diagram NaN values issue
095e8ca
@knsv
#5237 Async fix for clusters
afb69a3
@knsv
Merge branch '5237-unified-layout-common-renderer' of github.com:merm…
02eb8da 
…aid-js/mermaid into 5237-unified-layout-common-renderer
@ashishjain0512
adding handDrawn cypress test
9b9f4ea
@ashishjain0512
Updated handDrawn cypress test
734f1ad
@knsv
#5237 Fix for subroutine positioning
db725c1
@ashishjain0512
merge commit
39fdaef
@knsv
#5237 Fix for text alignment for handdrawn text using svg labels
7f9d4cd
@ashishjain0512
Merge from develop
3b2bb5a
@ashishjain0512
Fixed lint issue
2352137
@autofix-ci
[autofix.ci] apply automated fixes
d242395
@ashishjain0512
Fixed broken test
61cfb15
@ashishjain0512
Removed the un-necessary test
d2bbe83
@ashishjain0512
Ignore codeql warning
9b42ffd
@ashishjain0512 ashishjain0512 added this pull request to the merge queue Aug 12, 2024
Merged via the queue into develop with commit 87b2084 Aug 12, 2024
29 checks passed
@ashishjain0512 ashishjain0512 deleted the 5237-unified-layout-common-renderer branch August 12, 2024 12:38
@sidharthv96 sidharthv96 mentioned this pull request Oct 10, 2024
Open
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ashishjain0512 ashishjain0512 ashishjain0512 left review comments

@sidharthv96 sidharthv96 sidharthv96 left review comments

@aloisklink aloisklink Awaiting requested review from aloisklink

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Make common layout and render engines that can be used by many diagrams
4 participants
@knsv @sidharthv96 @ashishjain0512 @pbrolin47