@elmaurer/react-native-remix-icon/README.md

remix icons for react-native

# react-native-remix-icon

this icon set includes all icons from the latest [remix icon set](https://remixicon.com/) (4.6.0)

## Requirements

this package depends on react-native-svg, therefor install the latest version of react-native-svg

**npm:**

```shell
npm i react-native-svg
```

**yarn:**

```shell
yarn add react-native-svg
```

## Usage

### Icon Component

```tsx
import {Icon} from "@elmaurer/react-native-remix-icon";

const Component = () => {
    return (<Icon name={'account-box-fill'}/>)
};
```

### IconProps

the interface extends from ``SvgProps``, which comes from ``react-native-svg``

| **Name** | **Description**                      | **Type** | **Default** |
|----------|--------------------------------------|----------|-------------|
| name     | exact same name like remix icon has  | IconName | -           |
| color    | fills the icon with the given color  | string   | `#000`      |
| size     | sets width and height to given value | number   | `24`        |

### Individual Icon Component

this solution uses the ``SvgProps`` interface aswell, with a default color of ``#000``

```tsx
import {ArrowLeftSLine} from "@elmaurer/react-native-remix-icon";

const Component = () => {
    return (<ArrowLeftSLine/>)
};
```