Material-BottomNavigation


Source link: https://github.com/sephiroth74/Material-BottomNavigation

Material Bottom Navigation Library


Lightweight Bottom Navigation library component inspired by the Google Material Design Guidelines at https://www.google.com/design/spec/components/bottom-navigation.html

This project is also inspired by https://github.com/roughike/BottomBar

Table of contents

Installation

In your project's build.gradle file add the following line to the dependencies group:

compile 'it.sephiroth.android.library.bottomnavigation:bottom-navigation:2.0.1-rc1' 

Usage

Usage of the BottomNavigation widget is very easy. Just place it in your layout.xml like this:

<?xml version="1.0" encoding="utf-8"?> <android.support.design.widget.CoordinatorLayout android:id="@+id/CoordinatorLayout01"  xmlns:android="http://schemas.android.com/apk/res/android"
  xmlns:app="http://schemas.android.com/apk/res-auto"  xmlns:tools="http://schemas.android.com/tools"
  android:layout_width="match_parent"  android:layout_height="match_parent"
  android:fitsSystemWindows="true">
...your content...

<it.sephiroth.android.library.bottomnavigation.BottomNavigation

android:id="@+id/BottomNavigation"

android:layout_width="match_parent"

android:layout_height="wrap_content"

android:layout_gravity="bottom"

app:bbn_entries="@menu/bottombar_menu_4items"

app:bbn_scrollEnabled="true"

app:bbn_badgeProvider="@string/bbn_badgeProvider"

app:layout_behavior="@string/bbn_phone_view_behavior" /> </android.support.design.widget.CoordinatorLayout>

All the menu main configurations are defined within the xml menu resource itself. Here's an example of a menu with 4 items:

<?xml version="1.0" encoding="utf-8"?> <menu xmlns:android="http://schemas.android.com/apk/res/android"  xmlns:app="http://schemas.android.com/apk/res-auto"
  android:background="@android:color/black"
  app:bbn_badgeColor="#FFFF0000"  app:bbn_rippleColor="#33ffffff">
  <item

android:id="@+id/bbn_item1"

android:color="@color/colorPrimary"

android:icon="@drawable/ic_cloud_off_white_24dp"

android:title="Cloud Sync" />
  <item

android:id="@+id/bbn_item2"

android:color="@android:color/holo_green_dark"

android:icon="@drawable/ic_cast_connected_white_24dp"

android:title="Chromecast" />  <item

android:id="@+id/bbn_item3"

android:color="@android:color/holo_orange_dark"

android:icon="@drawable/ic_mail_white_24dp"

android:title="Mail" />
  <item

android:id="@+id/action4"

android:color="#FF5252"

android:icon="@drawable/ic_format_list_numbered_white_24dp"

android:title="List" /> </menu>

Examples

4 shifting items menu 3 fixed items menu
4 items no background Tablet mode
4 items without changing background.
Menu show/hide feature is also disabled
Menu can be easily setup for (left or right) tablet support.

**For a Live demo** [click here]( https://appetize.io/app/19up38k8e7vbqgq6gpg8p873t8?device=nexus5&scale=100&orientation=portrait&osVersion=7.0)

Sizing

Dimensions and paddings follow the Google giudelines

Tablets

The View supports tablet mode too (Left or Right). In order to enable tablet mode this is the configuration that should be used:

<it.sephiroth.android.library.bottomnavigation.BottomNavigation
  android:id="@+id/BottomNavigation"
  android:layout_width="match_parent"
  android:layout_height="wrap_content"
  android:layout_gravity="start"
  app:bbn_entries="@menu/bottombar_menu_3items"
  app:bbn_badgeProvider="@string/bbn_badgeProvider"
  app:layout_behavior="@string/bbn_tablet_view_behavior" />

Styling

The xml menu supports the following attributes in the <menu> tag:

<declare-styleable name="BottomNavigationMenu">
  <!-- menu default background color -->
  <attr name="android:background" />

 <!-- default badge color -->
  <attr name="bbn_badgeColor" format="color" />

<!-- animation duration for the menu items -->
  <attr name="bbn_itemAnimationDuration" format="integer" />

<!-- ripple selector color -->
  <attr name="bbn_rippleColor" format="color" />

<!-- menu item active color -->
  <attr name="bbn_itemColorActive" format="color" />

<!-- menu item inactive color -->
  <attr name="bbn_itemColorInactive" format="color" />

<!-- menu item disabled color -->
  <attr name="bbn_itemColorDisabled" format="color" />

<!-- force fixed behavior and always display item labels -->
  <!-- default implementation is false and the labels are -->
  <!-- shown only if there are less than 4 items in the menu -->
  <attr name="bbn_alwaysShowLabels" format="boolean" /> </declare-styleable>

Note: By default when there are 4 or 5 elements, only the selected item will display the label. In order to force all the items to always show their label, use bbn_alwaysShowLabels in the menu xml.

Badges

There's a basic support for badges using the default implementation. In order to display a badge in the current BottomNavigation view, all you have to do is:

 final BadgeProvider provider = bottomNavigationView.getBadgeProvider();

  provider.show(R.id.bbn_item3);

This code will show a little circle badge on the menu item with the id "bbn_item3".
You can define the default badge color inside the menu xml itself:

<menu xmlns:android="http://schemas.android.com/apk/res/android"
  xmlns:app="http://schemas.android.com/apk/res-auto"
  app:bbn_badgeColor="#FFFF0000">

 <item

android:id="@+id/bbn_item1"

android:color="@color/colorPrimary"

android:icon="@drawable/ic_cloud_off_white_24dp"

android:title="Cloud Sync" />

  ... </menu>

Then you can hide the badge using:

 bottomNavigation.getBadgeProvider().remove(R.id.bbn_item3);

Badges Customization

You can use your own Drawable by extending the BadgeProvider class. Once you've setup your new class you can tell the BottomNavigation view to use your class by specifying it in the "bbn_badgeProvider" attribute of your xml file.
For instance:

<it.sephiroth.android.library.bottomnavigation.BottomNavigation
  android:id="@id/BottomNavigation"
  android:layout_width="match_parent"
  android:layout_height="match_parent"
  android:layout_gravity="bottom"
  app:bbn_badgeProvider="my.custom.BadgeProviderCustom"
  app:bbn_entries="@menu/bottombar_menu_4items"
  app:layout_behavior="@string/bbn_phone_view_behavior" />

This will make your my.custom.BadgeProviderCustom the default BadgeProvider.

License

The MIT License (MIT)

Copyright (c) 2016 Alessandro Crugnola

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Resources

Android Button that morphs into a loading progress bar.

  • Fully customizable in the XML
  • Really simple to use
  • Makes your app looks cooler

A rxJava2 + ViewPager banner view for android. Automatically starts playing images and stops when on touching.

Transform any object into an async object (can be useful for VIPER).

Rx binding for AltBeacon.

Detect device shake in background (if you want), specifying sensitivity, range, counts.

This library helps android developers to implement something like iOS key value observer pattern (KVO).

Topics


2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes