README.md

react-remixicons

Description

Remix Icons as React Component

Installation

1. Add the library as a dependency from NPM:

    # yarn
    yarn add react-remixicon

    # npm
    npm install react-remixicon

2. Add a link to the font files in your project's HTML files:

    <link href="https://cdn.remixicon.com/releases/v1.3.1/remixicon.css" rel="stylesheet">

Demo

View the DEMO

API

Prop name	Type	Default	Description
name	string	required	Icon name
type	string	fill	Icon type
size	string	1x	Icon size
role	string	presentation	Icon role
style	Object	{}	Icon style
ref	React.ref	null	Icon node

Code example

import React from 'react';
import  Icon  from 'react-remixicon';

export default class App extends React.Component {
  render() {
    return (
      <Icon name="home-3" type="line" size="3x" />
    );
  }
}