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(mindmap): correctly render ampersand (&) #6315

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

Conversation

nour0205
Copy link

📑 Summary

Fixes an issue where ampersands (&) were not rendering properly in Mindmap nodes. This was caused by using .text(description), which escapes special characters, instead of .html(description).

Resolves #6308

📏 Design Decisions

Issue: When rendering text inside Mindmap nodes, .text() was escaping special characters like &, causing them to display incorrectly.
Solution: Updated createText.ts to use .html(description) instead of .text(description), ensuring proper rendering.
Impact: This fix allows ampersands (&) and other special HTML characters to be displayed correctly without breaking existing functionality.

📋 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 23, 2025

⚠️ No Changeset found

Latest commit: f993640

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 Feb 23, 2025
Copy link

netlify bot commented Feb 23, 2025

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit f993640
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/67bb75d29d62d0000882cbd4
😎 Deploy Preview https://deploy-preview-6315--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 23, 2025

Open in Stackblitz

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

commit: f993640

Copy link

codecov bot commented Feb 23, 2025

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 3.89%. Comparing base (de40d80) to head (f993640).

Files with missing lines Patch % Lines
packages/mermaid/src/rendering-util/createText.ts 0.00% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           develop   #6315      +/-   ##
==========================================
- Coverage     3.89%   3.89%   -0.01%     
==========================================
  Files          397     398       +1     
  Lines        41955   41966      +11     
  Branches       637     637              
==========================================
  Hits          1634    1634              
- Misses       40321   40332      +11     
Flag Coverage Δ
unit 3.89% <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/rendering-util/createText.ts 0.50% <0.00%> (ø)

... and 1 file with indirect coverage changes

Copy link

argos-ci bot commented Feb 23, 2025

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

Build Status Details Updated (UTC)
default (Inspect) ⚠️ Changes detected (Review) 75 changed Feb 23, 2025, 7:42 PM

@nour0205
Copy link
Author

Hi @sidharthv96 would you be able to review the Argos check on this PR? Let me know if anything needs to be adjusted. Thanks!

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.

Unable to render an Ampersand (&) on a MindMap
1 participant