Skip to content

Export the icon loader types - #7352

Merged
aloisklink merged 2 commits into
mermaid-js:developfrom
remcohaszing:export-icon-loader-type
Jan 29, 2026
Merged

aloisklink merged 2 commits into
mermaid-js:developfrom
remcohaszing:export-icon-loader-type

Conversation

@remcohaszing

Copy link
Copy Markdown
Contributor

📑 Summary

This exports the types AsyncIconLoader, SyncIconLoader, and IconLoader.

We want to use SyncIconLoader in mermaid-isomorphic.

See remcohaszing/mermaid-isomorphic#21

📏 Design Decisions

N/A

📋 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 Bot commented Jan 28, 2026 •

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 6483331

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
mermaid Minor

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

@netlify

netlify Bot commented Jan 28, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit 6483331
🔍 Latest deploy log https://app.netlify.com/projects/mermaid-js/deploys/697a12ecfffb7c00089dce77
😎 Deploy Preview https://deploy-preview-7352--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 project configuration.

We want to use `SyncIconLoader` in `mermaid-isomorphic`.

See remcohaszing/mermaid-isomorphic#21
@remcohaszing
remcohaszing force-pushed the export-icon-loader-type branch from 3f0b8f6 to d6db0b0 Compare January 28, 2026 13:40
@pkg-pr-new

pkg-pr-new Bot commented Jan 28, 2026 •

Copy link
Copy Markdown

Open in StackBlitz

@mermaid-js/examples

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

mermaid

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

@mermaid-js/layout-elk

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

@mermaid-js/layout-tidy-tree

npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/layout-tidy-tree@7352

@mermaid-js/mermaid-zenuml

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

@mermaid-js/parser

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

@mermaid-js/tiny

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

commit: 6483331

@codecov

codecov Bot commented Jan 28, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 3.59%. Comparing base (09d0650) to head (6483331).
⚠️ Report is 3 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           develop   #7352   +/-   ##
=======================================
  Coverage     3.59%   3.59%           
=======================================
  Files          474     474           
  Lines        47514   47514           
  Branches       740     740           
=======================================
  Hits          1706    1706           
  Misses       45808   45808           
Flag Coverage Δ
unit 3.59% <ø> (ø)

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

Files with missing lines Coverage Δ
packages/mermaid/src/mermaid.ts 0.42% <ø> (ø)
packages/mermaid/src/rendering-util/icons.ts 1.17% <ø> (ø)
🚀 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 Bot commented Jan 28, 2026 •

Copy link
Copy Markdown

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

Build Status Details Updated (UTC)
default (Inspect) ✅ No changes detected - Jan 29, 2026, 8:55 AM

@aloisklink aloisklink left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good! Thanks @remcohaszing!

It would be nice to have some TSDoc comments that explain what these types are for, now that they're exported, but I think that's something that could be improved in a future PR.

@aloisklink
aloisklink added this pull request to the merge queue Jan 29, 2026
Merged via the queue into mermaid-js:develop with commit 2e87fae Jan 29, 2026
27 of 29 checks passed
@remcohaszing
remcohaszing deleted the export-icon-loader-type branch January 29, 2026 12:20
@remcohaszing

Copy link
Copy Markdown
Contributor Author

I see a new release was made 2 days ago, but this change is not included. Why could that be?

@aloisklink

Copy link
Copy Markdown
Member

I see a new release was made 2 days ago, but this change is not included. Why could that be?

The mermaid@11.12.3 release was only a hotfix/patch release to fix a security issue.

This change should go out in the next regular release, but since there's a lot of stuff in develop, it might unfortunately take a while, since there's some more expensive visual regression tests that are only done on develop before a release is made, which sometimes catches issues that our cheaper CI on PRs didn't catch.

This was referenced Mar 3, 2026
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.

3 participants