BottomSheet


Source link: https://github.com/Kennyc1012/BottomSheet

# BottomSheet

#Features

  • Both list and grid style
  • Custom Views
  • Simple Messages
  • Light and Dark theme as well as custom themeing options
  • XML style support
  • Tablet support
  • Share Intent Picker
  • API 14+

#Using BottomSheet To get started using BottomSheet, first you'll need to create a menu resource file with the defined actions.

<?xml version="1.0" encoding="utf-8"?> <menu xmlns:android="http://schemas.android.com/apk/res/android">

<item

android:id="@+id/share"

android:icon="@drawable/ic_share_grey_600_24dp"

android:title="Share" />

<item

android:id="@+id/upload"

android:icon="@drawable/ic_cloud_upload_grey_600_24dp"

android:title="Upload" />

<item

android:id="@+id/copy"

android:icon="@drawable/ic_content_copy_grey_600_24dp"

android:title="Copy" />

<item

android:id="@+id/print"

android:icon="@drawable/ic_print_grey_600_24dp"

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

Then create a BottomSheet via the Builder interface

new BottomSheet.Builder(getActivity())
.setSheet(R.menu.bottom_sheet)
.setTitle(R.string.options)
.setListener(myListener)
.show();

#Simple Messages BottomSheet can also display a simple message like a standard dialog. Setting one up is just as simple

new BottomSheet.Builder(this)
  .setTitle(R.string.title)
  .setMessage(R.string.message)
  .setPositiveButton(R.string.ok)
  .setNegativeButton(R.string.close)
  .setIcon(R.drawable.my_icon)
  .setListener(myListener)
  .show();

To handle which button was pressed, the onSheetDismissed(BottomSheet bottomSheet, @DismissEvent int dismissEvent) will supply the DismissEvent that occurred. Possible values are: DISMISS_EVENT_BUTTON_POSITIVE, DISMISS_EVENT_BUTTON_NEGATIVE, DISMISS_EVENT_BUTTON_NEUTRAL, DISMISS_EVENT_SWIPE, and DISMISS_EVENT_MANUAL

#Custom Views For even further customization, you can set the BottomSheet to use a custom view.

View v = ...  new BottomSheet.Builder(this)
  .setView(v)
  .show();

There are a few limitations when using a custom view. First, it MUST have a background set or it will appear transparent. Second, the root layout dimensions should always be layout_width="match_parent and layout_height="wrap_content. Lastly, you will need to manage any click events as the BottomSheetListener can not determine anything from your custom view. If setting a custom view, all other builder settings will be ignored.

#Styling BottomSheet comes with both a Light and Dark theme to accommodate most scenarios. However, if you want to customize the color more, you can create your own style and supply it to the builder.
Customizable attributes are:

<!-- The background color of the Bottomsheet --> <attr name="bottom_sheet_bg_color" format="color" /> <!-- The text appearance of the title --> <attr name="bottom_sheet_title_text_appearance" format="reference" /> <!-- The text appearance of the list items --> <attr name="bottom_sheet_list_text_appearance" format="reference" /> <!-- The text appearance of the grid items --> <attr name="bottom_sheet_grid_text_appearance" format="reference" /> <!-- The text appearance of the message --> <attr name="bottom_sheet_message_text_appearance" format="reference" /> <!-- The text appearance of the title for a message Bottomsheet--> <attr name="bottom_sheet_message_title_text_appearance" format="reference" /> <!-- The text appearance of the buttons --> <attr name="bottom_sheet_button_text_appearance" format="reference" /> <!-- The color to tint the Bottomsheet icon --> <attr name="bottom_sheet_item_icon_color" format="color" /> <!-- The spacing between grid items --> <attr name="bottom_sheet_grid_spacing" format="dimension" /> <!-- The bottom padding of the grid --> <attr name="bottom_sheet_grid_bottom_padding" format="dimension" /> <!-- The top padding of the grid --> <attr name="bottom_sheet_grid_top_padding" format="dimension" /> <!-- The selector to be used for the items in the list/grid --> <attr name="bottom_sheet_selector" format="reference" /> <!-- The number of columns to show when using the grid style --> <attr name="bottom_sheet_column_count" format="integer" />

Then create a style and pass it into the Builder

<style name="MyBottomSheetStyle" parent="@style/BottomSheet">
  <item name="bottom_sheet_bg_color">@android:color/holo_blue_light</item>
  <item name="bottom_sheet_title_text_appearance">@style/TitleAppearance</item>
  <item name="bottom_sheet_list_text_appearance">@style/ListAppearance</item>
  <item name="bottom_sheet_grid_text_appearance">@style/GridAppearance</item> </style>  <style name="TitleAppearance" parent="BottomSheet.Title.TextAppearance">
  <item name="android:textColor">@android:color/holo_green_light</item> </style>  <style name="ListAppearance" parent="BottomSheet.ListItem.TextAppearance">
  <item name="android:textColor">@android:color/holo_red_light</item>
  <item name="android:textSize">18sp</item> </style>  <style name="GridAppearance" parent="BottomSheet.GridItem.TextAppearance">
  <item name="android:textColor">@android:color/holo_red_light</item>
  <item name="android:textSize">20sp</item> </style>
new BottomSheet.Builder(getActivity(), R.style.MyBottomSheetStyle)
.setSheet(R.menu.bottom_sheet)
.setTitle(R.string.options)
.setListener(myListener)
.show();

##Icons Based on the Material Design Guidelines, icons for a linear list styled BottomSheet should be 24dp, where as a grid styled BottomSheet should be 48dp.

#Share Intents BottomSheet can also be used to create a Share Intent Picker that will be styled like the ones found in Android 5.x+. To create one, simply call one of the static createShareBottomSheet methods.

// Create the intent for sharing Intent intent = new Intent(Intent.ACTION_SEND);
 intent.setType("text/*");
 intent.putExtra(Intent.EXTRA_TEXT, "My text to share");
 // Pass the intent into the createShareBottomSheet method to generate the BottomSheet. BottomSheet share = BottomSheet.createShareBottomSheet(getActivity(), intent, "My Title");
 // Make sure that it doesn't return null! If the system can not handle the intent, null will be returned. if (share != null) share.show();
 // By default, it will be styled as a list. For a grid, pass the boolean value true after the title parameter

For further customization of the share intent including which apps will be either be shown or not shown, see the full signature of createBottomSheet

#Callbacks BottomSheet uses the BottomSheetListener for callbacks

// Called when the BottomSheet it first displayed onSheetShown(BottomSheet bottomSheet)  // Called when the BottomSheet has been dismissed. Passed value of dismissEvent signifies how the BottomSheet was dismiss. see [BottomSheetListener](https://github.com/Kennyc1012/BottomSheet/blob/master/library/src/main/java/com/kennyc/bottomsheet/BottomSheetListener.java) for possible values onSheetDismissed(BottomSheet bottomSheet, @DismissEvent int dismissEvent)  // Called when an item is selected from the BottomSheet onSheetItemSelected(BottomSheet bottomSheet, MenuItem item)

#Upgrading From 1.x When upgrading to 2.x from a 1.x release, some changes will have to be made.

  • All of the builder methods for settings colors have been removed. All customzing should be done through themes.
  • The style attributes have been change to text appearances rather than colors.
  • The Builder constructor no longer takes a menu object. You will need to call setSheet(...).
  • The onSheetDismissed callback now takes an int as an argument for simple message support.
  • The gradle dependency has changed and needs to be updated.

#Including in your project To include BottomSheet in your project, make the following changes to your build.gradle file

Add repository

allprojects {

  repositories {

...

maven {
 url "https://jitpack.io" 
}

  
}
 
}

Add dependency

dependencies {

  compile 'com.github.Kennyc1012:BottomSheet:2.3.4' 
}

#Contribution Pull requests are welcomed and encouraged. If you experience any bugs, please file an issue

License

Copyright 2015 Kenny Campagna  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. 

Resources

This library provides an easy way for configure retrofit for use a 2 layer cache (RAM and Disk).

Animated placeholder in desert style.

Super simple RecyclerView adapter using Data Binding Technology.

An EditText which can remember last input, free developer from managing cache everywhere themselves.

Android LyricView that accepts lrc stream as input. A powerful lyric parser is also contained.

Logger is a logging tool helps unify release log and debug log, with some little advanced usage.

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