https://github.com/coreui/coreui-icons-vue

CoreUI Icons for Vue.js. Dedicated component used to implement CoreUI Icons SVG set in Vue.js.
https://github.com/coreui/coreui-icons-vue

coreui-icons-free icons icons-packaged iconset vue vue-icons

Last synced: 2 months ago
JSON representation

CoreUI Icons for Vue.js. Dedicated component used to implement CoreUI Icons SVG set in Vue.js.

• Host: GitHub
• URL: https://github.com/coreui/coreui-icons-vue
• Owner: coreui
• License: mit
• Created: 2019-11-05T13:08:06.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2024-09-14T10:59:49.000Z (about 1 year ago)
• Last Synced: 2025-07-03T06:28:47.511Z (3 months ago)
• Topics: coreui-icons-free, icons, icons-packaged, iconset, vue, vue-icons
• Language: TypeScript
• Homepage: https://coreui.io/icons/
• Size: 1.75 MB
• Stars: 13
• Watchers: 3
• Forks: 5
• Open Issues: 27
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  

    

  





  Official Vue.js component for CoreUI Icons and CoreUI Icons PRO.

  


  Explore CoreUI Icons for Vue docs »

  


  


  Report bug

  ·

  Request feature

  ·

  Blog



## Status

[![NPM](https://img.shields.io/npm/v/@coreui/icons-vue/latest?style=flat-square&color=brightgreen)][coreui]

[![Downloads](https://img.shields.io/npm/dm/@coreui/icons-vue.svg?style=flat-square)][coreui]

[![License](https://img.shields.io/npm/l/@coreui/vue?style=flat-square)][coreui]

[coreui]: https://coreui.io/icons

## Installation

```bash

npm install @coreui/icons

npm install @coreui/icons-vue

```

or

```bash

yarn add @coreui/icons

yarn add @coreui/icons-vue

```

## Use

### Single icon

```jsx

import { CIcon } from '@coreui/icons-vue';

import { cifAu } from '@coreui/icons';

...

...

```

### All icons

```jsx

import { CIcon } from '@coreui/icons-vue';

import * as icon from '@coreui/icons';

...

...

```

## API

| property | type | description |

| --- | --- | --- |

| customClassName | `string` \| `object` \| `string[]` | Use for replacing default CIcon component classes. Prop is overriding the 'size' prop. |

| icon | `string` \| `string[]` | Name of the icon placed in React object or SVG content. |

| height | `number` | The height attribute defines the vertical length of an icon. |

| size | `sm` \| `md` \|`lg` \| `xl` \| `xxl` \| `3xl` \| `4xl` \| `5xl` \| `6xl` \| `7xl` \| `8xl` \| `9xl` | Size of the icon. |

| use | `string` | If defined component will be rendered using `use` tag. |

| title | `string` | Title tag content. |

| width | `number` | The width attribute defines the horizontal length of an icon. |