Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/asdsolutions-os/duo-navigation-drawer
A flexible, easy to use, unique drawer library for your Android project.
https://github.com/asdsolutions-os/duo-navigation-drawer
android android-drawer android-library android-menu drawer drawerlayout layout library menu navigation-drawer slide
Last synced: 7 days ago
JSON representation
A flexible, easy to use, unique drawer library for your Android project.
- Host: GitHub
- URL: https://github.com/asdsolutions-os/duo-navigation-drawer
- Owner: asdsolutions-os
- License: apache-2.0
- Created: 2017-04-24T07:35:19.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-03-01T09:08:45.000Z (over 5 years ago)
- Last Synced: 2024-10-15T11:23:04.035Z (22 days ago)
- Topics: android, android-drawer, android-library, android-menu, drawer, drawerlayout, layout, library, menu, navigation-drawer, slide
- Language: Java
- Homepage: http://psdcompany.nl/
- Size: 21.1 MB
- Stars: 1,098
- Watchers: 26
- Forks: 191
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Duo Navigation Drawer [  ](https://bintray.com/psdcompany/maven/duo-navigation-drawer/_latestVersion) [](https://travis-ci.org/PSD-Company/duo-navigation-drawer) [](https://android-arsenal.com/details/1/5779)
This Android library provides an easy way to create an alternative navigation
drawer for android. Instead of a drawer that slides over the main content of
the Activity, this lets the content slide away and reveal a menu below it.
By default it applies a scaling effect on the content and menu.
### AndroidX
If you're still using legacy Android Support libraries you can use v2.0.8. AndroidX is supported by default since v3.0.0.
## Demo
[][2]
The demo app is included in the `app` module in this project.
## Getting Started
### Prerequisites
You can download a jar from GitHub's [releases page][1].
Or use Gradle:
```gradle
repositories {
mavenCentral() // jcenter() works as well because it pulls from Maven Central
}
dependencies {
compile 'nl.psdcompany:duo-navigation-drawer:3.0.0'
}
```
Or Maven:
```xml
nl.psdcompany
duo-navigation-drawer
3.0.0
pom
```
### Installing
#### 1. Add the `DuoNavigationDrawer` view to your activity
```xml
```
#### 2. Add the `content view` view to your `drawer`
Add the a content view to your drawer by adding the attribute: `app:content` to your drawer.
```xml
```
or, you can also add a view within the drawer with the tag `content`.
```xml
```
#### 3. Add the `menu view` view to your `drawer`
Add the a menu view to your drawer by adding the attribute: `app:menu` to your drawer.
```xml
```
or, you can also add a view within the drawer with the tag `menu`.
```xml
```
#### 4. Initialize the drawer view
The API of the `DuoNavigationDrawer` is mostly the same as the original `DrawerLayout` from the Android design library. Same for `DuoDrawerToggle` which is a modified version of the `ActionBarDrawerToggle` to support the `DuoDrawerLayout`.
```Java
DuoDrawerLayout drawerLayout = (DuoDrawerLayout) findViewById(R.id.drawer);
DuoDrawerToggle drawerToggle = new DuoDrawerToggle(this, drawerLayout, toolbar,
R.string.navigation_drawer_open,
R.string.navigation_drawer_close);
drawerLayout.setDrawerListener(drawerToggle);
drawerToggle.syncState();
```
## Customization
### Using the `DuoMenuView`
If you want your `menu` to look like the demo. you should consider using the `DuoMenuView` For more info using the `DuoMenuView` click [here][3].
### Effects
All values are `Float` values. The default values are used in the example.
#### Content scaling effect
The scaling applied on the content when sliding it from left to right.
```xml
app:contentScaleClosed="1.0"
app:contentScaleOpen="0.7"
```
#### Menu scaling effect
The scaling applied on the menu when sliding the content from left to right.
```xml
app:menuScaleClosed="1.1"
app:menuScaleOpen="1.0"
```
#### Click to close surface scaling effect
The scaling applied on the click to close surface when the drawer is open.
```xml
app:clickToCloseScale="0.7"
```
#### Menu alpha effect
The alpha on the menu when sliding the content from left to right.
```xml
app:menuAlphaClosed="0.0"
app:menuAlphaOpen="1.0"
```
#### Content margin factor
This value is used to calculate how much of the content should be visible when the content is slided to the right. This is calculated with the width of the `DuoDrawerLayout` when: `getWidth * marginFactor`. So setting this to 1.0f will slide the content out of the activity. The default is 0.7f.
```xml
app:marginFactor="0.7"
```
## Apps using the DuoNavigationDrawer
* [Bagels & Beans](https://play.google.com/store/apps/details?id=nl.dtt.bagelsbeans)
* [Hebban](https://play.google.com/store/apps/details?id=nl.dtt.hebban)
Feel free to apply your app to the list by sending me an email with a link to your app in the play store.
## Developed By
* Alexander Pot -
## Donations
If you'd like to support DuoNavigationDrawer development, you could make some donations here:
* [](http://www.paypal.me/alexanderpot)
Thank you very much in advance!
## License
Copyright 2017 Alexander Pot
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
[1]: https://github.com/PSD-Company/duo-navigation-drawer/releases
[2]: https://www.youtube.com/watch?v=Batgo5dDxyw
[3]: https://github.com/PSD-Company/duo-navigation-drawer/blob/master/dev/MENU_VIEW.md