# remixicon-react

> Remix Icon for React

Latest version **1.0.0** (published 2020-11-09) · (MIT AND OFL-1.1) license · 0 weekly downloads

## Install

```sh
npm install remixicon-react
pnpm add remixicon-react
yarn add remixicon-react
bun add remixicon-react
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2020-11-09 |
| First published | 2020-04-23 |
| Weekly downloads | 0 |
| License | (MIT AND OFL-1.1) |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.4 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 16 |
| Author | Pascal Corpet |
| Maintainers | lascap, zozoens31 |
| Keywords | remixicon, react, remix, icons |

## Links

- npm: https://www.npmjs.com/package/remixicon-react
- Repository: https://github.com/bayesimpact/remixicon-react
- Issues: https://github.com/bayesimpact/remixicon-react/issues
- npm.io page: https://npm.io/package/remixicon-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
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads
- [@react-md/material-icons](https://npm.io/package/@react-md/material-icons.md) — 1.6K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2020-11-09
- 0.1.0 — 2020-04-23

## README

# remixicon-react [![npm package](https://img.shields.io/npm/v/remixicon-react.svg?style=flat-square)](https://npmjs.org/package/remixicon-react) [![Remix Icons version](https://img.shields.io/badge/remixicon-v2.4.0-blue.svg?style=flat-square)](https://remixicon.com/) [![build status](https://img.shields.io/travis/bayesimpact/remixicon-react/master.svg?style=flat-square)](https://travis-ci.org/bayesimpact/remixicon-react)
[Remix Icons](https://remixicon.com/) for React packaged as single components

This repo is based on the very good [mdi-react](https://github.com/levrik/mdi-react) package.

## Installation

```bash
npm install remixicon-react
# or if you use Yarn
yarn add remixicon-react
```

## Usage

Just search for an icon on [remixicon.com](https://remixicon.com) and look for its name.  
The name translates to PascalCase followed by the suffix `Icon` in `remixicon-react`.  

For example the icons named `alert-line` and `alert-fill`:

```javascript
import AlertLineIcon from 'remixicon-react/AlertLineIcon';
import AlertFillIcon from 'remixicon-react/AlertFillIcon';

const MyComponent = () => {
  return (
    <div>
      {/* The default color is the current text color (currentColor) */}
      <AlertLineIcon color="#fff" />
      {/* The default size is 24 */}
      <AlertFillIcon className="some-class" size={16} />
      {/* This sets the icon size to the current font size */}
      <AlertIcon size="1em" />
    </div>
  );
};
```

To change the color on hover you can just use your own class and plain CSS.

```css
.some-class:hover {
  fill: red;
}
```

You can also add default styling via the `remixicon-icon` class.

```css
.remixicon-icon {
  background-color: green;
}
```

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