Skip to content

Commit

Permalink
Added usage.
Browse files Browse the repository at this point in the history
  • Loading branch information
pedroadame committed May 7, 2015
1 parent 7168382 commit 0cae9ea
Showing 1 changed file with 22 additions and 34 deletions.
56 changes: 22 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,47 +2,35 @@ MaterialNavigationDrawer
========================
##**Note:** This fork is for using the native translucent status bar for following the Material Design specs better.

Navigation Drawer Activity with material design style and simplified methods<br>
[![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-MaterialNavigationDrawer-brightgreen.svg?style=flat)](https://android-arsenal.com/details/1/1114)&ensp;&ensp;&ensp;&ensp;&ensp;[![Donate](https://www.paypalobjects.com/en_GB/i/btn/btn_donate_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=K4GJELZKNEF68)
For docs, see the original repository.

It requires 10+ API and android support v7 (Toolbar)<br>

[Download example apk](https://raw.github.com/neokree/MaterialNavigationDrawer/master/example.apk)<br>

If you are using MaterialNavigationDrawer in your app and would like to be listed here, please let me know via [email](mailto:[email protected])! <br>

## Set up a Navigation Drawer
check the [wiki page](https://github.com/neokree/MaterialNavigationDrawer/wiki/Set-Up-a-Navigation-Drawer-Activity)

## How to import
## How to use
Add this to your build.gradle:
```java
repositories {
mavenCentral()
maven{
url "https://jitpack.io"
}
}

dependencies {
compile 'it.neokree:MaterialNavigationDrawer:1.3.3'
compile 'com.github.Kinnonii:MaterialNavigationDrawer:1.4.0'
}
```
If you want to use this fork, just extend the TranslucentKitKatStatusBar theme in the values-v19/styles.xml and add`<item name="android:windowTranslucentStatus">true</item>` to your styles-v21.xml. Be sure to work with dimens.xml if you have independent activities that doesn't extends from MaterialNavigationDrawer. Here are the files:

You don't know how to do something? Visit the [wiki](https://github.com/neokree/MaterialNavigationDrawer/wiki)!<br>
You need some examples? See the [example project](https://github.com/neokree/MaterialNavigationDrawer/tree/master/MaterialNavigationDrawer)!

### Useful issues
For open a useful issue, please follow this little guide:

1. Check if your issue is not opened yet. This prevent to have different questions to the same problem.
2. When you open an issue, please add the library version used, devices tested and related api.

### External libraries used
[Material-Ripple](https://github.com/balysv/material-ripple)

<img src="https://raw.github.com/neokree/MaterialNavigationDrawer/master/art/screen1.jpg" alt="screenshot" width="300px" height="auto" />
<img src="https://raw.github.com/neokree/MaterialNavigationDrawer/master/art/screen2.jpg" alt="screenshot" width="300px" height="auto" />
<img src="https://raw.github.com/neokree/MaterialNavigationDrawer/master/art/screen3.jpg" alt="screenshot" width="300px" height="auto" />
<img src="https://raw.github.com/neokree/MaterialNavigationDrawer/master/art/screen4.jpg" alt="screenshot" width="300px" height="auto" />
<img src="https://raw.github.com/neokree/MaterialNavigationDrawer/master/art/screen6.jpg" alt="screenshot" width="300px" height="auto" />
<img src="https://raw.github.com/neokree/MaterialNavigationDrawer/master/art/screen7.jpg" alt="screenshot" width="300px" height="auto" />
<img src="https://raw.github.com/neokree/MaterialNavigationDrawer/master/art/screen8.jpg" alt="screenshot" width="300px" height="auto" />
<img src="https://raw.github.com/neokree/MaterialNavigationDrawer/master/art/screen5.jpg" alt="screenshot" width="600px" height="auto" />
####values/dimens.xml
```xml
<dimen name="padding_app_bar_top">0dp</dimen> <!-- Apply this as paddingTop of your app_bar.xml root element -->
<dimen name="app_bar_size">56dp</dimen> <!-- Apply this as layout_height of your app_bar.xml root element -->
```
####values-v19/dimens.xml
```xml
<dimen name="padding_app_bar_top">24dp</dimen> <!-- Apply this as paddingTop of your app_bar.xml root element -->
<dimen name="app_bar_size">80dp</dimen> <!-- Apply this as layout_height of your app_bar.xml root element -->
```
####values-v21/dimens.xml
```xml
<dimen name="padding_app_bar_top">24dp</dimen> <!-- Apply this as paddingTop of your app_bar.xml root element -->
<dimen name="app_bar_size">80dp</dimen> <!-- Apply this as layout_height of your app_bar.xml root element -->
```

0 comments on commit 0cae9ea

Please sign in to comment.