Skip to content

Commit 7ab1d79

Browse files
committed
README is updated: AppleHeader is added
1 parent 901a6ef commit 7ab1d79

1 file changed

Lines changed: 24 additions & 4 deletions

File tree

README.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,21 @@ npm i @freakycoder/react-native-header-view
4141
"react-native-dynamic-vector-icons": ">= x.x.x"
4242
```
4343

44-
# Usage
44+
# Options
4545

46-
## Modern Header Usage
46+
- AppleHeader
47+
- ModernHeader
48+
- ClassicHeader
4749

48-
#### Basic Usage
50+
# Usage
51+
52+
## Apple Header Usage
4953

54+
```js
55+
<AppleHeader />
56+
```
5057

58+
## Modern Header Usage
5159

5260
```js
5361
<ModernHeader />
@@ -103,12 +111,24 @@ npm i @freakycoder/react-native-header-view
103111

104112
### Configuration - Props
105113

114+
#### Apple Header Props
115+
116+
dateTitle, largeTitle, imageSource, onPress
117+
118+
119+
| Property | Type | Default | Description |
120+
| ----------- | :------: | :-----------------: | ----------------------------------------- |
121+
| dateTitle | string | MONDAY, 27 NOVEMBER | set your own string instead of date title |
122+
| largeTitle | string | For You | set your own large title |
123+
| imageSource | image | image | set your own image |
124+
| onPress | function | null | use this to set onPress functionality |
125+
106126
#### Modern Header Props
107127

108128
| Property | Type | Default | Description |
109129
| ------------------ | :-------: | :------------: | --------------------------------------------------------------- |
110130
| styles | styles | styles | use this to change main style of the header |
111-
| text | string | "Header Title" | set the header's title |
131+
| text | string | Header Title | set the header's title |
112132
| textStyle | style | style | set your own style for the header's text |
113133
| left | number | 16 | use this to set left icon's align |
114134
| right | number | 16 | use this to set right icon's align |

0 commit comments

Comments
 (0)