@iconoir/vue
TypeScript icon, indicating that this package has built-in type declarations

7.7.0 • Public • Published

Iconoir - Vue

NPM Version NPM Monthly Downloads NPM License

Iconoir is an open-source library with 1300+ unique SVG icons, designed on a 24x24 pixels grid. No premium icons, no email sign-up, no newsletters.

@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

npm Yarn pnpm
npm i @iconoir/vue yarn add @iconoir/vue 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>

Properties

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 name Default 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.

<script setup>
import { IconoirProvider, Check } from '@iconoir/vue';
</script>

<template>
  <IconoirProvider
    :icon-props="{
      'color': '#AAAAAA',
      'stroke-width': 1,
      'width': '1em',
      'height': '1em',
    }"
  >
    <SomeOtherContainer>
      <Check />
    </SomeOtherContainer>
  </IconoirProvider>
</template>

Icon names

The Vue components are named as PascalCase variations of their reference names (i.e. airplane-helix-45deg becomes AirplaneHelix45deg).

Readme

Keywords

Package Sidebar

Install

npm i @iconoir/vue

Homepage

iconoir.com

Weekly Downloads

483

Version

7.7.0

License

MIT

Unpacked Size

4.12 MB

Total Files

1593

Last publish

Collaborators

  • lucaburgio
  • paescuj
  • sammarks-code