Skip to content

Commit 3411e8f

Browse files
committed
Update readme.md
1 parent 99efb57 commit 3411e8f

File tree

1 file changed

+28
-6
lines changed

1 file changed

+28
-6
lines changed

README.md

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# react-native-navbar-style
1+
# React Native Navbar Style
2+
3+
React Native Navbar Style is a [react-native](http://facebook.github.io/react-native/) library for styling the bottom navigation bar on Android devices.
4+
25

36
## Getting started
47

@@ -25,13 +28,32 @@
2528
```
2629
compile project(':react-native-navbar-style')
2730
```
28-
31+
##Requirements
32+
33+
Changing the NavigationBar color is only supported on Android Lollipop(API 21) and above.
34+
Changing the NavigationBar theme (light or dark) is supported only on Android Oreo(API 26) and above.
2935

3036
## Usage
37+
38+
Importing
39+
3140
```javascript
32-
import RNNavbarStyle from 'react-native-navbar-style';
41+
import NavbarStyle from 'react-native-navbar-style';
42+
```
3343

34-
// TODO: What to do with the module?
35-
RNNavbarStyle;
44+
Changing color - setNavBarColor(color)
45+
46+
```javascript
47+
NavbarStyle.setNavbarColor('#16a085');
3648
```
37-
49+
50+
Changing Theme - setLightNavbar(isLight)
51+
52+
```javascript
53+
//Makes the navigation bar icons dark.
54+
//This is suitable for light navbar colors.
55+
await NavbarStyle.setLightNavbar(true);
56+
57+
//Normal Navbar(Light Icons)
58+
await NavbarStyle.setLightNavbar(false);
59+
```

0 commit comments

Comments
 (0)