iconoir/packages/iconoir-react
2022-07-05 16:06:47 +00:00
..
src Update build artifacts 2022-06-08 08:59:39 +00:00
.npmignore Add npmignore 2021-05-19 20:37:16 +01:00
.svgrrc.json Use svgr to generate icons 2021-05-29 15:10:27 +02:00
CHANGELOG.md Update iconoir-react/iconoir-react-native packages 2021-07-05 17:11:54 +02:00
LICENSE Add License 2021-05-19 19:51:25 +01:00
package.json Release Version v5.1.4 2022-07-05 16:06:47 +00:00
README.md ci: automatically create new releases with tags instead of each push to master 2022-03-09 19:32:29 -05:00
tsconfig.esm.json feat: add support for ESM modules (#135) 2022-03-23 11:11:43 -04:00
tsconfig.json fix: use regular TS bundling to fix published release 2022-03-08 10:02:42 -05:00

React Iconoir Icons

NPM Version NPM Monthly Downloads NPM License

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.

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