Skip to content

Commit 7131d13

Browse files
new sections
1 parent b2a1da0 commit 7131d13

1 file changed

Lines changed: 53 additions & 1 deletion

File tree

README.md

Lines changed: 53 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,53 @@
1-
# react-native-feather
1+
## React Native Feather Icons
2+
3+
[![npm version](https://img.shields.io/npm/v/react-native-feather.svg?style=flat-square)](https://www.npmjs.com/package/react-native-feather)
4+
[![npm downloads](https://img.shields.io/npm/dm/react-native-feather.svg?style=flat-square)](https://www.npmjs.com/package/react-native-feather)
5+
6+
#### What is react-native-feather?
7+
8+
react-native-feather is a collection of simply beautiful open source icons for React Native. Each icon is designed on a 24x24 grid with an emphasis on simplicity, consistency and readability.
9+
10+
#### Based on Feather Icons `v4.28.0`
11+
12+
## Installation
13+
14+
1. Ensure sure you've installed [`react-native-svg`](https://github.com/react-native-community/react-native-svg)
15+
2. `npm i react-native-feather`
16+
17+
### Usage
18+
19+
```javascript
20+
import { Activity } from "react-native-feather";
21+
22+
const App = () => {
23+
return <Activity />;
24+
};
25+
```
26+
27+
Icons can be configured with inline props:
28+
29+
```javascript
30+
<Camera stroke="red" fill="#fff" width={32} height={32} />
31+
```
32+
33+
You can also include the whole icon pack:
34+
35+
```javascript
36+
import * as Icon from "react-native-feather";
37+
38+
const App = () => {
39+
return <Icon.Camera />;
40+
};
41+
```
42+
43+
### Properties
44+
45+
Any [Svg property](https://github.com/react-native-community/react-native-svg#common-props) and the following:
46+
47+
| Prop | Description | Default |
48+
| ----------------- | -------------------------------------------------------------------- | ---------------- |
49+
| **`width`** | Width of the icon. | `24` |
50+
| **`height`** | Height of the icon. | `24` |
51+
| **`stroke`** | The stroke prop refers to the color outline the icon. | `"currentColor"` |
52+
| **`strokeWidth`** | The strokeWidth prop specifies the width of the outline on the icon. | `2` |
53+
| **`fill`** | The fill prop refers to the color inside the icon. | `"none"` |

0 commit comments

Comments
 (0)