# react-native-icomoon

> Icomoon icon compatible

Latest version **0.1.1** (published 2020-11-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-native-icomoon
pnpm add react-native-icomoon
yarn add react-native-icomoon
bun add react-native-icomoon
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2020-11-13 |
| First published | 2020-11-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 76.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Edwin Wong |
| Maintainers | edwinwong90 |
| Keywords | react-native, ios, android, icomoon, icon |

## Links

- npm: https://www.npmjs.com/package/react-native-icomoon
- Repository: https://github.com/edwinwong90/react-native-icomoon
- Homepage: https://github.com/edwinwong90/react-native-icomoon#readme
- Issues: https://github.com/edwinwong90/react-native-icomoon/issues
- npm.io page: https://npm.io/package/react-native-icomoon

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads
- [@react-md/material-icons](https://npm.io/package/@react-md/material-icons.md) — 1.6K weekly downloads

## Recent versions

- 0.1.1 (latest) — 2020-11-13

## README

# react-native-icomoon
React Native Icommon

## Installation
React Native Icomoon is using react-native-svg to render icon. Make sure install it correctly [https://github.com/react-native-svg/react-native-svg#installation](https://github.com/react-native-svg/react-native-svg#installation)

```sh
npm install react-native-icomoon react-native-svg
```

or

```sh
yarn add react-native-icomoon react-native-svg
```

## Usage

#### Create re-useable component
```js
import Icomoon from "react-native-icomoon"
import type { IconMoonProps } from 'react-native-icomoon'
import json from './selection.json'

type IconProps = Omit<IconMoonProps, "iconSet">

export default function Icon({ name, ...restProps }: IconProps) {
  return <Icomoon iconSet={json} name={name} {...restProps} />
}
```

#### Use
```js
import Icon from './Icon'

<Icon name="firefox" color="tomato" size={50} />
```

#### iconList

You can use the iconList method to see a complete list of icons you can use.

```js
import { iconList } from "react-icomoon";
import json from './selection.json'

iconList(json);

// sample output
[
  "document",
  "camera",
  "genius",
  "chat",
  //...
]
```

## Props List
| Name              | Type          | Default   | Sample                        |
|-------------------|---------------|-----------|-------------------------------|
| iconSet           | Object        | undefined | "selection.json file content" |
| name              | String        | undefined | "home"                        |
| size              | Number,String | undefined | "1em", 10, "100px"            |
| color             | String        | undefined | "red", "#f00", "rgb(0,0,0)"   |




## License

MIT

---
_Source: https://npm.io/package/react-native-icomoon · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._