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

CoreUI Icons Component for React. CoreUI Icons SVG Set implementation for React.
https://github.com/coreui/coreui-icons-react

coreui-icons coreui-icons-free icons icons-set react react-icons react-icons-component svg

Last synced: 2 months ago
JSON representation

CoreUI Icons Component for React. CoreUI Icons SVG Set implementation for React.

• Host: GitHub
• URL: https://github.com/coreui/coreui-icons-react
• Owner: coreui
• License: mit
• Created: 2020-02-06T12:40:05.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-03-22T09:55:12.000Z (10 months ago)
• Last Synced: 2024-05-21T19:14:44.789Z (8 months ago)
• Topics: coreui-icons, coreui-icons-free, icons, icons-set, react, react-icons, react-icons-component, svg
• Language: TypeScript
• Homepage: https://coreui.io/react/docs/components/icon/
• Size: 596 KB
• Stars: 5
• Watchers: 4
• Forks: 6
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

    

  





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

  


  Explore CoreUI Icons for React docs »

  


  


  Report bug

  ·

  Request feature

  ·

  Blog



## Status

[![npm package][npm-badge]][npm]

[![NPM downloads][npm-download]][npm]

![react](https://img.shields.io/badge/react-^17.0.2-lightgrey.svg?style=flat-square&logo=react)

[npm-badge]: https://img.shields.io/npm/v/@coreui/icons-react/latest?style=flat-square

[npm]: https://www.npmjs.com/package/@coreui/icons-react

[npm-download]: https://img.shields.io/npm/dm/@coreui/icons-react.svg?style=flat-square

## Installation

```bash

npm install @coreui/icons

npm install @coreui/icons-react

```

or

```bash

yarn add @coreui/icons

yarn add @coreui/icons-react

```

## Use

### Single icon

```jsx

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

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

...

render() {

  return (

    

  )

}

...

```

### All icons

```jsx

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

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

...

render() {

  return (

    

  )

}

...

```

## API

| property | type | description |

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

| className | `string` | A string of all className you want applied to the component. |

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