-
-
Notifications
You must be signed in to change notification settings - Fork 6.6k
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.
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
New Flowchart Shapes (with new syntax) #5825
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…mermaid-js/mermaid into knsv/new-shapes
sidharthv96
requested changes
Oct 2, 2024
sidharthv96
reviewed
Oct 2, 2024
Co-authored-by: Alois Klink <alois@aloisklink.com>
@ashishjain0512, Thank you for the contribution! |
Merged
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📑 Summary
This pull request introduces several new flowchart shapes along with their test, updates to the configuration files, and improvements to the documentation.
**The most important changes include a guide for other contributors on how to add a new custom shape for flowcharts.
New Tests and Configurations:
cypress/integration/rendering/flowchart-v2.spec.js
: Added a test to render self-loops in flowcharts.cypress/integration/rendering/newShapes.spec.ts
: Introduced comprehensive tests for new shapes, including various looks, directions, labels, and styles.cypress/integration/rendering/oldShapes.spec.ts
: Added tests for existing shapes with different looks and directions.Configuration Updates:
.cspell/cspell.config.yaml
: Added new words to the dictionary definitions.Documentation Enhancements:
docs/adding_new_shape/Readme.md
: Added detailed documentation on the available utilities for creating new shapes, instructions for adding new shapes, and information on running Cypress tests.These changes collectively enhance the robustness of the flowchart rendering capabilities and provide clear guidelines for extending the shape library.
Brief description about the content of your PR.
Resolves #
📏 Design Decisions
Describe the way your implementation works or what design decisions you made if applicable.
📋 Tasks
Make sure you
MERMAID_RELEASE_VERSION
is used for all new features.pnpm changeset
and following the prompts. Changesets that add features should beminor
and those that fix bugs should bepatch
. Please prefix changeset messages withfeat:
,fix:
, orchore:
.