-
-
Notifications
You must be signed in to change notification settings - Fork 8.7k
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(core): restore core svg file-loader #10820
Merged
Merged
+56
−15
Conversation
This file contains 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
✅ [V2]
To edit notification comments on pull requests, go to your Netlify site configuration. |
Size Change: +549 B (0%) Total Size: 11.8 MB
ℹ️ View Unchanged
|
⚡️ Lighthouse report for the deploy preview of this PR
|
Size Change: +554 B (0%) Total Size: 12.2 MB
ℹ️ View Unchanged
|
slorber
added
the
Argos
Add this label to run UI visual regression tests. See argos.yml GH action.
label
Jan 6, 2025
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Argos
Add this label to run UI visual regression tests. See argos.yml GH action.
CLA Signed
Signed Facebook CLA
pr: bug fix
This PR fixes a bug in a past release.
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.
Motivation
When I extracted our v3.7 SVGR plugin from Docusaurus core (#10677), I also removed default support for SVG file loaders.
Users rely on it to reference local SVG files from CSS:
#10677 (comment)
Although the v3.7.0 SVGR plugin brings that support, it's not really its responsibility to do so.
This PR restores file-loader support for SVGs, even if sites do not use the SVGR plugin (which is included by default in our preset). Asking sites not using SVGR to use the SVGR plugin so that they benefit from SVG file-loader would be a bit awkward.
Unfortunately, the underlying solution is not super elegant due to how Webpack rules work, and registering a second svg rule will not "override" the first, but both rules will be applied subsequently from last to first. I had to make the plugin "enhance" the existing core rule.
Test Plan
Dogfood test with a SVG referenced inside a CSS file
Our existing site pages using SVGR
Test links
https://deploy-preview-10820--docusaurus-2.netlify.app/tests/docs
https://deploy-preview-10820--docusaurus-2.netlify.app/docs/markdown-features/assets#inline-svgs