[!Important] This project is maintained by developer from Ukraine 🇺🇦

I do my best, but due to Russia's ongoing full-scale invasion of Ukraine, I barely have the energy to support open source projects.

If my work has been useful to you, please consider supporting Ukraine or me personally.

Even your $1 has an impact!

A superset standalone icon-components for Vue with zero dependencies. Designed for ease of use and high performance.

• Easy to use
  • No plugins required! Compatible with any build tools.
  • Designed for the best compatibility with IDE auto-completion (Demo).
  • Zero dependencies.
  • SSR / SSG friendly.
  • TypeScript support.
  • Unified API across all icon sets.
• High performance
  • Does not require any external resources like fonts, css, images.
  • The icon code is embedded in your bundle.
  • Supports tree shaking, so only those icons that you have used will be included in the bundle.
  • Works offline.
• Powered by iconify.

Live demo: https://stackblitz.com/edit/iconify-prerendered-demo?file=src%2FApp.vue

Install the appropriate icon set

npm i @iconify-prerendered/vue-<icon-set-name>

# Bootstrap Icons
npm i @iconify-prerendered/vue-bi

# Material Design Icons
npm i @iconify-prerendered/vue-mdi

Import icon-component from a set like usual.

<script setup>
// Import two icons from Font Awesome Brands
import { IconVuejs, IconJs } from '@iconify-prerendered/vue-fa-brands';
// Import one Icon from Material Design icons
import { IconCardsHeart } from '@iconify-prerendered/vue-mdi';
</script>

<template>
  <p>
    <IconJs />
    <IconCardsHeart />
    <IconVuejs />
  </p>
</template>

Only these three icons will be included in your bundle. Your bundler may tree-shake all other icons.

That's all you need. No plugins, extra configs, IDE extensions or something else.

By default, all icons have only two attributes: role="img" and aria-hidden="true". While you are free to redefine these attributes or add new ones for each icon, you might want to apply certain attributes, such as class or style, to all icons within a set.

To achieve this, you can re-export icons through a new Proxy and include default attributes

import * as defaultIcons from '@iconify-prerendered/vue-mdi';

// accessing to icon through this Proxy will add additional attributes
export const themedIcons = new Proxy({} as typeof defaultIcons, {
  get(_, iconKey: keyof typeof defaultIcons) {
    return () =>
      defaultIcons[iconKey]({
        class: 'pre-defined-class',
        // ... any other attributes
      });
  },
});

The code for generating the icon sets is distributed under the MIT license. The icon sets themselves are distributed under the license of their author.

1. Install Deno.
2. Run deno task generate for generate all collections. Params:
   • --version or -v specify version base for generated packages. Optional.
   • --prefix or -p specify with a collection to generate. Maybe multiple times. Optional.
   • --no-replace-ids disable replacing ids. Required for a test case. Optional.
   • --output or -o directory to place generated files. Optional.
3. Run deno task test for run all tests. See more about test running.

You can benchmark two versions of icon sets. To do that:

1. Generate baseline icon set by command: deno task generate -p=fluent-emoji -o=benckmarks/generated/baseline
2. Make any changes to the generation process or whatever
3. Generate tested icon set by command: deno task generate -p=fluent-emoji -o=benckmarks/generated/test
4. Run benchmark by deno bench --allow-env
5. Go to step #2