Socket
Socket
Sign inDemoInstall

iconoir-react

Package Overview
Dependencies
3
Maintainers
4
Versions
54
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    iconoir-react

React library for Iconoir, the biggest open source icon library with tons of free icons.


Version published
Weekly downloads
13K
decreased by-7.33%
Maintainers
4
Created
Weekly downloads
 

Readme

Source

Iconoir - React

NPM Version NPM Monthly Downloads NPM License

Iconoir is an open-source library with 1300+ unique SVG icons, designed on a 24x24 pixels grid. No premium icons, no email sign-up, no newsletters.

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

npmYarnpnpm
npm i iconoir-reactyarn add iconoir-reactpnpm add 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 nameDefault value
color"currentColor"
width"1.5em"
height"1.5em"
strokeWidth1.5

IconoirProvider

Tired of specifying the same props for every single icon, every time you use them? So were we. Use IconoirProvider to set the default icon props for everything inside IconoirProvider.

import { IconoirProvider, Check } from 'iconoir-react';

return (
  <IconoirProvider
    iconProps={{
      color: '#AAAAAA',
      strokeWidth: 1,
      width: '1em',
      height: '1em',
    }}
  >
    <SomeOtherContainer>
      <Check />
    </SomeOtherContainer>
  </IconoirProvider>
);

Icon names

The React components are named as PascalCase variations of their reference names (i.e. airplane-helix-45deg becomes AirplaneHelix45deg).

Keywords

FAQs

Last updated on 25 Apr 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc