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

feat(flowchart): support multiline edge labels using \n #6439

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

feat(flowchart): support multiline edge labels using \n #6439

wants to merge 1 commit into from

Conversation

nour0205
Copy link

📑 Summary

Adds support for multiline edge labels in flowcharts by converting \n into <br/> before rendering.

This enables authors to write:

mermaid
graph TD
  A -->|"Line 1\nLine 2"| B

Resolves #6436

📏 Design Decisions

Patches the flowchart layout algorithm (layout-algorithms/dagre/index.ts) to replace \n with
before calling graph.setEdge().

image

📋 Tasks

Make sure you

  • 📖 have read the contribution guidelines
  • 💻 have added necessary unit/e2e tests.
  • 📓 have added documentation. Make sure MERMAID_RELEASE_VERSION is used for all new features.
  • 🦋 If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Mar 30, 2025

⚠️ No Changeset found

Latest commit: 05ac5dd

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions bot added the Type: Enhancement New feature or request label Mar 30, 2025
@netlify Netlify
Copy link

netlify bot commented Mar 30, 2025 •
edited
Loading

✅ Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit 05ac5dd
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/67e8aa5e2685360008a0a882
😎 Deploy Preview https://deploy-preview-6439--mermaid-js.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@pkg-pr-new pkg.pr.new
Copy link

pkg-pr-new bot commented Mar 30, 2025

Open in Stackblitz

npm i https://pkg.pr.new/mermaid-js/mermaid@6439

npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/layout-elk@6439

npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/mermaid-zenuml@6439

npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/parser@6439

commit: 05ac5dd

@codecov Codecov
Copy link

codecov bot commented Mar 30, 2025 •
edited
Loading

Codecov Report

Attention: Patch coverage is 0% with 4 lines in your changes missing coverage. Please review.

Project coverage is 3.86%. Comparing base (936d107) to head (05ac5dd).

Files with missing lines Patch % Lines
...rc/rendering-util/layout-algorithms/dagre/index.js 0.00% 4 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           develop   #6439      +/-   ##
==========================================
- Coverage     3.86%   3.86%   -0.01%     
==========================================
  Files          412     412              
  Lines        43189   43193       +4     
  Branches       664     664              
==========================================
  Hits          1670    1670              
- Misses       41519   41523       +4
Flag Coverage Δ
unit 3.86% <0.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
...rc/rendering-util/layout-algorithms/dagre/index.js 0.00% <0.00%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@argos-ci Argos CI
Copy link

argos-ci bot commented Mar 30, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
default (Inspect) ✅ No changes detected - Mar 30, 2025, 2:29 AM

@nour0205 nour0205 mentioned this pull request Mar 30, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@ashishjain0512 ashishjain0512

Labels
Type: Enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Support \n in edge labels for multiline edge text
2 participants
@nour0205 @ashishjain0512