iconoir

mirror of https://github.com/iconoir-icons/iconoir synced 2024-06-01 13:32:27 +02:00

History

Daniel Martin 9565207e23 Update iconoir-react to v2.0.0 - Add CHANGELOG for better visibility of changes - Update README to reflect changes made in update - Update version in package.json and package-lock.json		2021-06-01 22:46:34 +01:00
..
bin	Prettify build.js	2021-05-29 15:10:27 +02:00
src	Regenerate src files using iconoir v4.3.1	2021-06-01 22:44:55 +01:00
.gitignore	Use svgr to generate icons	2021-05-29 15:10:27 +02:00
.npmignore	Add npmignore	2021-05-19 20:37:16 +01:00
.prettierrc.json	Use svgr to generate icons	2021-05-29 15:10:27 +02:00
.svgrrc.json	Use svgr to generate icons	2021-05-29 15:10:27 +02:00
CHANGELOG.md	Update iconoir-react to v2.0.0	2021-06-01 22:46:34 +01:00
LICENSE	Add License	2021-05-19 19:51:25 +01:00
package-lock.json	Update iconoir-react to v2.0.0	2021-06-01 22:46:34 +01:00
package.json	Update iconoir-react to v2.0.0	2021-06-01 22:46:34 +01:00
README.md	Update iconoir-react to v2.0.0	2021-06-01 22:46:34 +01:00
tsconfig.json	Use svgr to generate icons	2021-05-29 15:10:27 +02:00
tsup.config.json	Use svgr to generate icons	2021-05-29 15:10:27 +02:00

README.md

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

Installation

yarn add iconoir-react

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`
`github`	`GitHub`
`github-outline`	`GitHubOutline`
`gitlab-full`	`GitLabFull`
`linkedin`	`LinkedIn`
`tiktok`	`TikTok`
`youtube`	`YouTube`