rollup-plugin-md-icon
v1.0.0
Published
Minify md icons and font in your app.
Downloads
69
Maintainers
Readme
rollup-plugin-md-icon
Generates fonts with only the symbols you use in your app ✨
Install
npm add -D rollup-plugin-md-icon
Usage
👷 During development
Do not use anything ! Just add this stylesheet in the header of your html document:
<head>
<link
id="symbols"
href="https://fonts.googleapis.com/icon?family=Material+Symbols+Outlined"
rel="stylesheet"
/>
</head>
This stylesheet serves a font that contains all symbols from fonts.googleapis.com (learn more)
📦 At build time
We'll need to convert the link above.
From here you can opt one of 2 strategies:
1️⃣ Serve minified font file from fonts.googleapis.com : See instructions on the wiki.
It's the easiest option. The plugin will update the href
in the final html to request a stylesheet that will load a font file that contains only the icons your app needs (That will count for 2 http requests).
2️⃣ Serve font file locally : See instructions on the wiki.
Less intuitive to implement but recommended. The plugin will download the stylesheet and the minified font so you have more control on how you serve them (e.g. bundling the stylesheet directly in a module, caching the font in a service worker, etc..)
Development
The monorepo of this plugin can be found here
How it works
The plugin scans the source code to build a list of all used icons called a codepoints list which is saved under the cache directory .mdicon
. The cache system is used to avoid downloading the fonts every time rollup runs (which can happen a lot during development). The cached codepoints list is used to generate minimal final font files or urls depending on which strategy you use at build time.
Known limitations
- The plugin scans all the files matching the provided glob pattern (option
include
) which means the final font could potentially includes icons that are or will not be used at runtime if some files are being excluded from the module graph at build time.
License
MIT