Vue Iconoir Icons

Iconoir is an open source library with 900+ SVG Icons. No premium icons, no email sign-up, no newsletters. You can browse the full suite of icons at iconoir.com.

@iconoir/vue is an open source package that exports these icons as Vue.js components that can be used in all of your Vue projects. Thanks to vue-demi, both Vue 2 and Vue 3 are supported.

Installation

yarn add @iconoir/vue

or

npm i @iconoir/vue

or

pnpm add @iconoir/vue

Usage

Vue 3:

<script setup>
import { Iconoir } from '@iconoir/vue';
</script>

<template>
  <Iconoir />
</template>

Vue 2:

<script>
import { Iconoir } from '@iconoir/vue';

export default
    components: {
        Iconoir
    }
}
</script>

<template>
    <Iconoir />
</template>

Icons can take any standard SVG properties as optional props, e.g.

<Iconoir color="red" height="36" width="36" />

Default values for the most common props are given below:

Prop nameDefault value
color"currentColor"
width"1.5em"
height"1.5em"
stroke-width"1.5"

IconoirProvider

Tired of specifying the same props for every single icon, every time you use them? So were we. Use IconoirProvider to set the default icon props for everything inside IconoirProvider.

&lt;script setup&gt;
import { IconoirProvider, Check } from &#39;@iconoir/vue&#39;;
&lt;/script&gt;

&lt;template&gt;
  &lt;IconoirProvider
    :icon-props=&quot;{
      color: &#39;#AAAAAA&#39;,
      &#39;stroke-width&#39;: 1,
      width: &#39;1em&#39;,
      height: &#39;1em&#39;,
    }&quot;
  &gt;
    &lt;SomeOtherContainer&gt;
      &lt;Check /&gt;
    &lt;/SomeOtherContainer&gt;
  &lt;/IconoirProvider&gt;
&lt;/template&gt;

Icon names

For the most part, the Vue components are named as PascalCase variations of their reference names (i.e. add-circle-outline becomes AddCircleOutline). However, some names have been altered slightly either because they start with numerical digits, which would lead to invalid Vue component names, or because they are organisations which use PascalCase in their brand names, such as GitHub. The altered names are as follows:

Iconoir NameVue Component
1st-medalMedal1St
4k-displayDisplay4K
4x4-cellCell4X4
360-viewView360
githubGitHub
github-outlineGitHubOutline
gitlab-fullGitLabFull
linkedinLinkedIn
tiktokTikTok
youtubeYouTube
More?
If you would like to use Iconoir on a different library or if you want to contribute to support a new library, open a feature request in our official GitHub repository.
Iconoir Logo
Parts of this content are ©2020-2023 by individual Iconoir contributors. Content available under a MIT License.