-
-
Notifications
You must be signed in to change notification settings - Fork 6.6k
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
chore: Remove public APIs for icons #5789
Conversation
We are planning to release an icons library separately. Till we figure out the APIs for those, all external surface for icons are removed, to avoid making a breaking change when the new library comes.
🦋 Changeset detectedLatest commit: eaae85c The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
✅ Deploy Preview for mermaid-js ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #5789 +/- ##
==========================================
+ Coverage 4.67% 5.02% +0.34%
==========================================
Files 348 336 -12
Lines 51597 48061 -3536
Branches 561 575 +14
==========================================
Hits 2413 2413
+ Misses 49184 45648 -3536
Flags with carried forward coverage won't be shown. Click here to find out more.
|
* develop: test: Skip architecture diagram [autofix.ci] apply automated fixes fix: Update diagram keyword
📑 Summary
We are planning to release an icons library separately.
Till we figure out the APIs for those, all external surface for icons are removed, to avoid making a breaking change when the new library comes.
The aws icons bundle also increased mermaid.min.js size by 50%, which is a problem for many libraries that ship mermaid without lazy loading.
📏 Design Decisions
Current plan is to create a library (or add support into mermaid), to consume iconify icons, so that users can integrate icons easily without having to create custom iconspacks for mermaid.
📋 Tasks
Make sure you
MERMAID_RELEASE_VERSION
is used for all new features.pnpm changeset
and following the prompts. Changesets that add features should beminor
and those that fix bugs should bepatch
. Please prefix changeset messages withfeat:
,fix:
, orchore:
.