Skip to content

fix(timeline): wrap long timeline titles properly #6405

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

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from

Conversation

nour0205
Copy link

📑 Summary

This PR fixes a layout bug in the Mermaid Timeline diagram where long titles do not wrap and instead overflow or shrink the diagram unnecessarily. The fix introduces robust text wrapping using SVG logic and proper positioning of the title block.

image

Resolves #6393

📏 Design Decisions

Replace the single element used for the diagram title with a group that contains dynamically calculated elements.
Implemented a wrapText utility in svgDraw.js that:
Splits the title string by whitespace.
Appends new lines when the current line exceeds the maximum width.
Maintains proper line height and alignment.
Centered the title visually by adjusting the x position based on the diagram’s width and manually shifting the group with text-anchor: middle.
Kept the implementation fully SVG-native (no ) for cross-browser consistency and to match Mermaid’s rendering style

📋 Tasks

Make sure you

  • [x ] 📖 have read the contribution guidelines
  • [x ] 💻 have added necessary unit/e2e tests.
  • [x ] 📓 have added documentation. Make sure MERMAID_RELEASE_VERSION is used for all new features.
  • [x ] 🦋 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:.

Copy link

changeset-bot bot commented Mar 22, 2025

⚠️ No Changeset found

Latest commit: dd16d30

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: Bug / Error Something isn't working or is incorrect label Mar 22, 2025
Copy link

pkg-pr-new bot commented Mar 22, 2025

Open in StackBlitz

npm i https://pkg.pr.new/mermaid-js/mermaid@6405
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/layout-elk@6405
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/mermaid-zenuml@6405
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/parser@6405

commit: dd16d30

Copy link

netlify bot commented Mar 22, 2025

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit 909f8c0
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/67e2aeb6f548c0000859f54a
😎 Deploy Preview https://deploy-preview-6405--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.

Copy link

codecov bot commented Mar 22, 2025

Codecov Report

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

Project coverage is 3.87%. Comparing base (5e2870f) to head (dd16d30).

Files with missing lines Patch % Lines
packages/mermaid/src/diagrams/timeline/svgDraw.js 0.00% 22 Missing ⚠️
.../mermaid/src/diagrams/timeline/timelineRenderer.ts 0.00% 18 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           develop   #6405      +/-   ##
==========================================
- Coverage     3.87%   3.87%   -0.01%     
==========================================
  Files          413     412       -1     
  Lines        43216   43238      +22     
  Branches       665     665              
==========================================
  Hits          1675    1675              
- Misses       41541   41563      +22     
Flag Coverage Δ
unit 3.87% <0.00%> (-0.01%) ⬇️

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

Files with missing lines Coverage Δ
.../mermaid/src/diagrams/timeline/timelineRenderer.ts 0.38% <0.00%> (-0.02%) ⬇️
packages/mermaid/src/diagrams/timeline/svgDraw.js 0.00% <0.00%> (ø)

... and 1 file with indirect coverage changes

🚀 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.

Copy link

argos-ci bot commented Mar 25, 2025

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

Build Status Details Updated (UTC)
default (Inspect) ⚠️ Changes detected (Review) 10 removed, 10 failures Apr 30, 2025, 9:30 PM

Copy link

netlify bot commented Apr 30, 2025

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit 623e8bd
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/68124299498d6d0008fbb87d
😎 Deploy Preview https://deploy-preview-6405--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.

Copy link

netlify bot commented Apr 30, 2025

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit dd16d30
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/6812947494cff80008275745
😎 Deploy Preview https://deploy-preview-6405--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.

@nour0205 nour0205 force-pushed the fix/timeline-title-wrap branch from 3cf9fa7 to 74b0191 Compare April 30, 2025 21:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Bug / Error Something isn't working or is incorrect
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Timeline Title Does Not Wrap Correctly
1 participant