diff --git a/DEV/github/screenshots_combined.jpg b/DEV/github/screenshots_combined.jpg new file mode 100644 index 000000000..375f61afc Binary files /dev/null and b/DEV/github/screenshots_combined.jpg differ diff --git a/FAQ.md b/FAQ.md index a2bf9d90c..2befa45cd 100644 --- a/FAQ.md +++ b/FAQ.md @@ -24,3 +24,18 @@ Each question and it's answer is hosted in a separate file within the FAQ folder ## CustomDrawerItem's * [A custom SecondaryDrawerItem that takes different name when its on disabled state](https://gist.github.com/AngleV/400377184386193c985d905bd97f2d40) + +## Asked super frequently + +### How can i create a drawer without a default selection +```kotlin +//just set the selection to -1 +slider.setSelectionAtPosition(-1) +``` + +### Can I lock the Drawer +As the MaterialDrawer will just create a normal DrawerLayout (with some magic around it) everything a normal +DrawerLayout can do is also available in the MaterialDrawer. +```kotlin +drawerLayout.setDrawerLockMode(int lockMode); //or (int lockMode, int edgeGravity) +``` \ No newline at end of file diff --git a/README.md b/README.md index 1edb39ffa..08bc74bdb 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,21 @@ # MaterialDrawer [![Download](https://api.bintray.com/packages/mikepenz/maven/com.mikepenz%3Amaterialdrawer/images/download.svg) ](https://bintray.com/mikepenz/maven/com.mikepenz%3Amaterialdrawer/_latestVersion) -![MaterialDrawer the flexible, easy to use, all in one drawer library for your android project.](./DEV/github/banner.png) +... the flexbile, easy to use, all in one drawer library for your Android project. -> Does your application **contain a Drawer**? Do you want to have it **up and running in less than 5 minutes**? Do you want your drawer to follow the **Android Design Guidelines**? -Do you have **profiles**? Do you need **flexibility**? Is Google's navigation Drawer of the **design support** not enough for you? Do you want a **simple and easy** to understand api? +------- -If any (or all) of these questions seem familiar, the **MaterialDrawer** is the perfect library for you all. +

+ What's included 🚀 • + Setup 🛠️ • + Migration Guide 🧬 • + WIKI / FAQ 📖 • + Used by • + Sample App +

-**Never** waste your time again. -It provides you with the easiest possible implementation of a navigation drawer for your application. -There is a Header with profiles (**AccountHeader**), a **MiniDrawer** for Tablets (like Gmail), provide -**custom DrawerItems**, **custom colors**, **custom themes**, ... **No limits** for customizations. +------- -### A quick overview of what's in it +### What's included 🚀 - **the easiest possible integration** - integrate in less than **5 minutes** - **uses the androidX support libraries** @@ -39,19 +42,13 @@ There is a Header with profiles (**AccountHeader**), a **MiniDrawer** for Table > If you upgrade from < 8.0.0 follow the [MIGRATION GUIDE](https://github.com/mikepenz/MaterialDrawer/blob/develop/MIGRATION.md) # Preview -## Demo -You can try it out here [Sample Application](https://play.google.com/store/apps/details?id=com.mikepenz.materialdrawer.app) -## Screenshots -![Image](DEV/github/screenshots1.png) -![Image](DEV/github/screenshots2.png) - -# WIKI / FAQ -You can find some frequently asked questions and other resources in the [WIKI / FAQ](FAQ.md) site. +## Screenshots 🎉 +![Image](DEV/github/screenshots_combined.jpg) # Setup -## Latest releases +## Latest releases 🛠 - Kotlin && New | [v8.0.0-b04](https://github.com/mikepenz/MaterialDrawer/tree/v8.0.0-b04) - Kotlin | [v7.0.0](https://github.com/mikepenz/MaterialDrawer/tree/v7.0.0) @@ -59,7 +56,7 @@ You can find some frequently asked questions and other resources in the [WIKI / - Java && AppCompat | [v6.0.9](https://github.com/mikepenz/MaterialDrawer/tree/v6.0.9) -## 1. Provide the gradle dependency +### 1. Provide the gradle dependency ```gradle implementation "com.mikepenz:materialdrawer:${lastestMaterialDrawerRelease}" @@ -78,10 +75,7 @@ implementation "com.mikepenz:materialdrawer-nav:${lastestMaterialDrawerRelease}" implementation "com.mikepenz:materialdrawer-iconics:${lastestMaterialDrawerRelease}" ``` -## v8.x.y -> Major release, migrates to use the FastAdapter v5. Check out the changelog or the [MIGRATION GUIDE](https://github.com/mikepenz/FastAdapter/blob/develop/MIGRATION.md) for more details - -## 2. Add the `Drawer` into the XML +### 2. Add the `Drawer` into the XML The `MaterialDrawerSliderView` has to be provided as child of the `DrawerLayout` and will as such act as the slider @@ -103,9 +97,9 @@ The `MaterialDrawerSliderView` has to be provided as child of the `DrawerLayout` android:fitsSystemWindows="true" /> ``` -## 3. Add the `DrawerStyle` to your theme +### 3. Add the `DrawerStyle` to your theme -``` +```xml ``` -# FAQ -### How can i create a drawer without a default selection -```java -//just set the selection to -1 -slider.setSelectionAtPosition(-1) -``` - -### Can I lock the Drawer -As the MaterialDrawer will just create a normal DrawerLayout (with some magic around it) everything a normal -DrawerLayout can do is also available in the MaterialDrawer. -```java -drawerLayout.setDrawerLockMode(int lockMode); //or (int lockMode, int edgeGravity) -``` - ### Prefer a Kotlin DSL? > Note this is currently not compatible with v8. Thanks to @zsmb13 there's now an (in)official Kotlin DSL wrapper for the MaterialDrawer https://github.com/zsmb13/MaterialDrawerKt -# Apps using the MaterialDrawer +# Used by (feel free to send me new projects) * [wall:splash](https://play.google.com/store/apps/details?id=com.mikepenz.unsplash)