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.

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

Fix Timeline LongText wrap issue #6258

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

Conversation

nour0205
Copy link

@nour0205 nour0205 commented Feb 6, 2025

📑 Summary

This PR fixes the issue where long text in Timeline diagrams overflows outside the color block instead of wrapping properly. The solution ensures text automatically wraps and stays inside the designated block.

Resolves #6182

📏 Design Decisions

  • Implemented automatic text wrapping inside Timeline diagram blocks.
  • Used CSS/SVG text-wrapping to prevent text overflow.
  • Maintained compatibility with existing Timeline diagrams

📋 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 Feb 6, 2025

⚠️ No Changeset found

Latest commit: 892a482

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

Copy link

netlify bot commented Feb 6, 2025

Deploy Preview for mermaid-js ready!

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

pkg-pr-new bot commented Feb 6, 2025

Open in Stackblitz

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

commit: 892a482

Copy link

codecov bot commented Feb 6, 2025

Codecov Report

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

Project coverage is 4.47%. Comparing base (e9e663f) to head (892a482).
Report is 76 commits behind head on develop.

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

Impacted file tree graph

@@            Coverage Diff             @@
##           develop   #6258      +/-   ##
==========================================
- Coverage     4.47%   4.47%   -0.01%     
==========================================
  Files          385     384       -1     
  Lines        54180   54192      +12     
  Branches       598     623      +25     
==========================================
  Hits          2425    2425              
- Misses       51755   51767      +12     
Flag Coverage Δ
unit 4.47% <0.00%> (-0.01%) ⬇️

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

Files with missing lines Coverage Δ
packages/mermaid/src/diagrams/timeline/svgDraw.js 0.00% <0.00%> (ø)

... and 9 files with indirect coverage changes

@nour0205 nour0205 mentioned this pull request Feb 6, 2025
Comment on lines +480 to +482
if (word.length * 8 > width) {
const splitWord = word.match(/.{1,10}/g) || []; // Split long words into chunks
words.push(...splitWord.reverse()); // Push chunks back into words
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hard-coding these values could cause issues if font size is different.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Timeline LongText wrap
2 participants