fix/label-escaping-htmlLabels-false - #7039
Closed
SAMARTHAGARWAL77 wants to merge 3 commits into
Closed
SAMARTHAGARWAL77 wants to merge 3 commits into
SAMARTHAGARWAL77 wants to merge 3 commits into
Conversation
✅ Deploy Preview for mermaid-js ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
🦋 Changeset detectedLatest commit: 93c55d5 The changes in this PR will be included in the next version bump. This PR includes changesets to release 7 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
github-actions
Bot
added
the
Type: Bug / Error
@mermaid-js/examples
mermaid
@mermaid-js/layout-elk
@mermaid-js/layout-tidy-tree
@mermaid-js/mermaid-zenuml
@mermaid-js/parser
@mermaid-js/tiny
commit: |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #7039 +/- ##
=======================================
Coverage 3.55% 3.56%
=======================================
Files 473 473
Lines 47454 47462 +8
Branches 730 734 +4
=======================================
+ Hits 1687 1690 +3
- Misses 45767 45772 +5
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
Author
|
Hi @darshanr0107 @dijitali , can you both review this. Thanks for your time. |
Author
|
Hi @shubhamparikh2704 @darshanr0107, Can you review this once. Thanks for your time. |
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
aloisklink
added a commit
to aloisklink/mermaid
that referenced
this pull request
Mar 2, 2026
When creating labels using `htmlLabels: false`, e.g.
```mermaid
---
config:
htmlLabels: false
---
flowchart TD
A[2 < 4 && 12 > 14]
```
The SVG node label gets rendered as
`2 < 4 && 12 > 14`. This is fine for HTML text, where we
use `.innerHTML` to set the value. But for non-HTML Labels, we use
`.textContent`, so we need to pass the unescaped values.
Ideally we would stop calling DOMPurify on this label when
`.textContent` is used, since the content doesn't need to be sanitized,
but adding a quick `<`/`>`/`&`-> `<`/`>`/`&` also works.
I've adapted this commit from mermaid-js#6406
and from mermaid-js#7039
Closes: mermaid-js#6406
Co-authored-by: khalil <5alil.landolsi@gmail.com>
Co-authored-by: Samarth <115448290+SAMARTHAGARWAL77@users.noreply.github.com>
3 of 4 tasks
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
Fixes escaping of special characters (
<,>,&,\) in node labels whenflowchart.htmlLabelsis set tofalse.Previously, these characters were either stripped or not rendered correctly, breaking the expected output when
htmlLabels: false.Resolves #7016
📏 Design Decisions
Updated
sanitizeText()incommon.tsto handle label escaping manually whenhtmlLabels: false.When
htmlLabels: true, existing DOMPurify logic remains unchanged.Escaping covers:
&→&<→<>→>\→\\Added test cases to verify that escaping works correctly and nothing breaks in
htmlLabels: truemode.No breaking changes; default behavior is preserved for users who rely on HTML labels.
📋 Tasks
Make sure you
MERMAID_RELEASE_VERSIONis used for all new features.pnpm changesetand following the prompts. Changesets that add features should beminorand those that fix bugs should bepatch. Please prefix changeset messages withfeat:,fix:, orchore:.