README.md

Official Vue.js component for CoreUI Icons and CoreUI Icons PRO.
Explore CoreUI Icons for Vue docs »

Report bug · Request feature · Blog

Status

Installation

npm install @coreui/icons
npm install @coreui/icons-vue

or

yarn add @coreui/icons
yarn add @coreui/icons-vue

Use

Single icon

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

...
<CIcon :icon="cilAu" size="xxl"/>
...

All icons

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

...
<CIcon :icon="icon.cilList" size="xxl"/>
...

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.