@sammarks/iconoir-react
v3.0.0
Published
React library for Iconoir icon set
Downloads
3
Readme
React Iconoir Icons
Iconoir is an open source library with 900+ SVG Icons. No premium icons, no email sign-up, no newsletters. You can browse the full suite of icons at iconoir.com.
iconoir-react
is an open source package that exports these icons as React.js components that can be used in all of your React projects.
Based on Iconoir Icons v4.4.0
.
Installation
yarn add iconoir-react
or
npm i iconoir-react
Usage
import React from 'react';
import { Iconoir } from 'iconoir-react';
const App = () => {
return <Iconoir />
};
export default App;
Icons can take any standard SVG properties as optional props, e.g.
<Iconoir color="red" height={36} width={36} />
Default values for the most common props are given below:
| Prop name | Default value | |-------------|----------------| | color | "currentColor" | | width | "1.5em" | | height | "1.5em" | | strokeWidth | 1.5 | | fill | "none" |
Icon names
For the most part, the React components are named as PascalCase variations of their reference names (i.e. add-circle-outline
becomes AddCircleOutline
). However, some names have been altered slightly either because they start with numerical digits, which would lead to invalid React component names, or because they are organisations which use PascalCase in their brand names, such as GitHub
. The altered names are as follows:
| Iconoir Name | React Component |
|------------------|-----------------|
| 1st-medal
| Medal1St
|
| 4k-display
| Display4K
|
| 4x4-cell
| Cell4X4
|
| 360-view
| View360
|
| github
| GitHub
|
| github-outline
| GitHubOutline
|
| gitlab-full
| GitLabFull
|
| linkedin
| LinkedIn
|
| tiktok
| TikTok
|
| youtube
| YouTube
|