Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wrathchaos/react-native-custom-icon

Medium Article: https://freakycoder.com/react-native-library-react-native-custom-icon-1ec0b734d691
https://github.com/wrathchaos/react-native-custom-icon

mobile-app mobile-development react-native react-native-component software-engineering

Last synced: 2 months ago
JSON representation

Medium Article: https://freakycoder.com/react-native-library-react-native-custom-icon-1ec0b734d691

Host: GitHub
URL: https://github.com/wrathchaos/react-native-custom-icon
Owner: WrathChaos
License: mit
Created: 2019-03-10T21:10:22.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2023-07-18T20:29:39.000Z (over 1 year ago)
Last Synced: 2024-11-02T14:51:38.325Z (2 months ago)
Topics: mobile-app, mobile-development, react-native, react-native-component, software-engineering
Language: JavaScript
Homepage: https://www.freakycoder.com
Size: 3.13 MB
Stars: 5
Watchers: 3
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        

[![Battle Tested ✅](https://img.shields.io/badge/-Battle--Tested%20%E2%9C%85-03666e?style=for-the-badge)](https://github.com/WrathChaos/react-native-custom-icon)

[![Custom Icon Library for React Native.](https://img.shields.io/badge/-Custom%20Icon%20Library%20for%20React%20Native.-lightgrey?style=for-the-badge)](https://github.com/WrathChaos/react-native-custom-icon)

[![npm version](https://img.shields.io/npm/v/react-native-custom-icon.svg?style=for-the-badge)](https://www.npmjs.com/package/react-native-custom-icon)

[![npm](https://img.shields.io/npm/dt/react-native-custom-icon.svg?style=for-the-badge)](https://www.npmjs.org/package/react-native-custom-icon)

![Platform - Android and iOS](https://img.shields.io/badge/platform-Android%20%7C%20iOS-blue.svg?style=for-the-badge)

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)







## Installation

Add the dependency:

### Pure React Native:

```js

npm i react-native-custom-icon

```

## Peer Dependencies

##### IMPORTANT! You need install them.

```json

"react": ">= 16.x",

"react-native": ">= 0.55.x",

"react-native-vector-icons": ">= 6.x.x"

```

## Basic Usage

```jsx

import MyIcon from "react-native-custom-icon";

import IcomoonConfig from "./assets/icomoon/selection.json";

;

```

## Documentation







##### Read how to use react-native-custom-icon on Medium blog. DO NOT FORGET to implement your .ttf file on iOS and Android original files!

### Configuration - Props

| Property |  Type  | Default | Description                                                         |

| -------- | :----: | :-----: | ------------------------------------------------------------------- |

| name     | string |  null   | use this to set icon's name                                         |

| color    | color  |  null   | use this to set icon's color                                        |

| size     | number |   16    | use this to change icon's size                                      |

| config   |  JSON  |  null   | must use this to provide which config and data to use as IconConfig |

## Author

FreakyCoder, [email protected]

## License

React Native Custom Icon Library is available under the MIT license. See the LICENSE file for more info.