# @coreui/icons-react

> Official React component for CoreUI Icons

Latest version **2.3.0** (published 2024-07-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install @coreui/icons-react
pnpm add @coreui/icons-react
yarn add @coreui/icons-react
bun add @coreui/icons-react
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.3.0 |
| Published | 2024-07-14 |
| First published | 2020-02-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 336.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | The CoreUI Team |
| Maintainers | coreui |
| Keywords | coreui, coreui-icons, coreui-react, icons, svg, svg-icons, layout, component, react |

## Links

- npm: https://www.npmjs.com/package/@coreui/icons-react
- Repository: https://github.com/coreui/coreui-icons-react
- Homepage: https://coreui.io/react/docs/components/icon/
- Issues: https://github.com/coreui/coreui-icons-react/issues
- npm.io page: https://npm.io/package/@coreui/icons-react

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [stockfish](https://npm.io/package/stockfish.md) — 27.0K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads

## Recent versions

- 2.3.0 (latest) — 2024-07-14
- 2.0.0-rc.6 (next) — 2021-10-18
- 2.2.1 — 2023-07-11
- 2.2.0 — 2023-07-11
- 2.1.0 — 2022-07-06
- 2.0.1 — 2021-12-16
- 2.0.0 — 2021-10-20
- 2.0.0-rc.5 — 2021-08-13
- 2.0.0-rc.4 — 2021-08-13
- 2.0.0-rc.3 — 2021-08-12
- 2.0.0-rc.1 — 2021-08-11
- 2.0.0-rc.0 — 2021-07-05
- 1.1.0 — 2021-03-02
- 1.0.3 — 2021-03-02
- 1.0.2 — 2020-07-23
- … 12 more at https://npm.io/package/@coreui/icons-react/versions

## README

<p align="center">
  <a href="https://coreui.io/">
    <img src="https://coreui.io/images/brand/coreui-icons.svg" alt="CoreUI Icons logo" height="50">
  </a>
</p>

<p align="center">
  Official React.js component for CoreUI Icons and CoreUI Icons PRO.
  <br>
  <a href="https://coreui.io/react/docs/components/icon/"><strong>Explore CoreUI Icons for React docs »</strong></a>
  <br>
  <br>
  <a href="https://github.com/coreui/coreui-icons/issues/new?template=bug_report.md">Report bug</a>
  ·
  <a href="https://github.com/coreui/coreui-icons/issues/new?template=feature_request.md">Request feature</a>
  ·
  <a href="https://blog.coreui.io/">Blog</a>
</p>


## 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 (
    <CIcon icon={cilList} size="xxl"/>
  )
}
...
```

### All icons

```jsx
import { CIcon } from '@coreui/icons-react';
import * as icon from '@coreui/icons';

...
render() {
  return (
    <CIcon icon={icon.cilList} size="xxl"/>
  )
}
...
```


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

---
_Source: https://npm.io/package/@coreui/icons-react · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._