iconoir/packages/iconoir-react-native
lucaburgio ecda46b0b8 Release Version v7.5.0 2024-03-02 10:24:36 +00:00
..
LICENSE Add my name to LICENSE 2021-06-15 10:26:23 +02:00
README.md Update icons naming example 2023-10-29 10:53:44 +01:00
package.json Release Version v7.5.0 2024-03-02 10:24:36 +00:00

README.md

Iconoir - React Native

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-native is an open source package that exports these icons as React Native components (react-native-svg) that can be used in all of your React Native projects.

Installation

npm Yarn
npm i iconoir-react-native react-native-svg yarn add iconoir-react-native react-native-svg

Usage

import React from 'react';
import { View } from 'react-native';
import { Iconoir } from 'iconoir-react-native';

const App = () => {
  return (
    <View>
      <Iconoir />
    </View>
  );
};

export default App;

Icons can take any react-native-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"

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-native';

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