hi-vue-icons

Hi, Vue Icons!

English | 中文说明

A Vue component for including inline SVG icons from different popular icon packs easily.

Features

• Works for both Vue 2 & 3
• Supports tree-shaking: only import the icons you want
• 30000+ icons from 21 popular icon packs, see here

Supported Icon Packs

Now the following 21 icon packs are supported:

Documentation

Search for icons and view the documentation here.

Installation

yarn add hi-vue-icons
# or
npm install hi-vue-icons

For Vue 2, you'll also need @vue/composition-api:

yarn add @vue/composition-api -D

Or if you are using Nuxt 2, you'll need @nuxtjs/composition-api instead:

yarn add @nuxtjs/composition-api -D

then add @nuxtjs/composition-api/module to the buildModules option in your nuxt.config.js, see here for details.

Import

Global Import

Import hi-vue-icons and install it into Vue in main.js. You can only import the icons you need to reduce the bundle size.

Vue 3

// main.js
import { createApp } from "vue";
import App from "./App.vue";

import { HiVueIcon, addIcons } from "hi-vue-icons";
import { FaFlag, RiZhihuFill } from "hi-vue-icons/icons";

addIcons(FaFlag, RiZhihuFill);

const app = createApp(App);
app.component("v-icon", HiVueIcon);
app.mount("#app");

If you don't care about the bundle size and want to import a whole icon pack, you may should:

// main.js
// import Font Awesome
import * as FaIcons from "hi-vue-icons/icons/fa";

const Fa = Object.values({ ...FaIcons });
addIcons(...Fa);

Vue 2

// main.js
import Vue from "vue";
import App from "./App.vue";

import { HiVueIcon, addIcons } from "hi-vue-icons";
import { FaFlag, RiZhihuFill } from "hi-vue-icons/icons";

addIcons(FaFlag, RiZhihuFill);

Vue.component("v-icon", HiVueIcon);

new Vue({
  render: h => h(App)
}).$mount("#app");

Local Import

import HiVueIcon from "hi-vue-icons";

export default {
  components: {
    "v-icon": HiVueIcon
  }
};

Usage

The icon names should be passed using kebab-case.

<template>
  <div>
    <v-icon name="fa-flag" />
    <v-icon name="ri-zhihu-fill" />
  </div>
</template>

For Font Awesome 5 icons, icons from regular pack have name prop values like fa-regular-flag. Icons from solid and brands pack have name prop values like fa-beer and fa-github.

See the documentation for more about the usage.

Props

Some examples could be found in the documentation.

Nuxt

When using Nuxt, you need to register hi-vue-icons as a plugin following Nuxt's documentation.

It should be noted that, hi-vue-icons should be added to the build.transpile option in your nuxt.config.js (see here for details):

export default {
  // ...
  build: {
    transpile: ["hi-vue-icons"]
  }
}

To render the icon component only on client-side, you may need to wrap it in a <client-only> tag:

<template>
  <div>
    <client-only>
      <v-icon name="fa-flag" />
      <v-icon name="ri-zhihu-fill" />
    </client-only>
  </div>
</template>

Vite

When using Vite, it is suggested to exclude hi-vue-icons from pre-bundling:

// vite.config.js

export default {
  // ...
  optimizeDeps: {
    exclude: ["hi-vue-icons/icons"]
  }
}

When using Vite's Server-Side Rendering (SSR) support (VuePress, Vite SSG, etc.), hi-vue-icons should be added to the ssr.noExternal option (see here for details):

// vite.config.js

export default {
  // ...
  ssr: {
    noExternal: ["hi-vue-icons"]
  }
}

Contributing

Contributions are welcomed, see the contribution guides.

Acknowledgements

• This project is inspired by and based on vue-awesome and react-icons

License

This project is MIT licensed. Icons are taken from other projects, so check the license of each accordingly.