npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

vite-plugin-mdicon2svg

v0.0.4

Published

Vite plugin to transform md-icon to svgs

Downloads

31

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

vdegennevdegenne

Keywords

vitevite-pluginmaterial-3material-web-componentsmwcoptimization

Readme

vite-plugin-mdicon2svg

Inline SVGs in place of <md-icon> in your project.

Key features:

  • 📥 SVGs are cached to minimize network solicitation
  • 🌐 SVGs are module-virtualized to avoid inline duplication and to help code-splitting.
  • 🛠️ Some options to customize the SVGs and/or match your configuration needs.

Usage

import {mdicon2svg} from 'vite-plugin-mdicon2svg';

export default defineConfig({
  plugins: [mdicon2svg({devMode: true})],
});

devMode: true indicates to download and inline SVGs during development (or else it's done only during build time by default).
However this is not the recommended approach for 2 reasons:

  • A request is made to fonts.gstatic.com servers for each new icon added inside your source if they are not cached yet.
  • Your source is re-analyzed on new changes so it can make development slower on older machines and delay page refresh.

Here's the recommended approach instead, remove devMode option:

plugins: [mdicon2svg()];

And add the following to your html to display the icons:

<head>
  <link
    id="symbols"
    href="https://fonts.googleapis.com/icon?family=Material+Symbols+Outlined"
    rel="stylesheet"
  />
</head>

(note: it's important to include id="symbols" in the tag here to inform the plugin to remove this link at build time.)

Now you can dev using normal symbols and at build time SVGs will be [downloaded] and inlined.

Variant

You can pass the variant you want in the options:

plugins: [
  mdicon2svg({
    variant: 'rounded', // 'outlined' by default
  }),
];

Fill

Sometimes your app needs some filled icons, you can write the following to instruct the plugin to inline the correct icon:

<md-icon fill>star</md-icon> ⭐😄👍

Install

npm i -D vite-plugin-mdicon2svg

Known limitations

  • This plugin relies on lit-html, and the SVGs are wrapped inside html tagged templates. That means you will need lit-html (or lit) installed in your project. That also means icons in raw html files won't get inlined.

License

MIT ©️ 2024 vdegenne