Note: we are not actively responding to issues right now. If you find a bug, please submit a PR.
Android Sliding Up Panel
This library provides a simple way to add a draggable sliding up panel (popularized by Google Music and Google Maps) to your Android application.
As seen in Umano Android App (now acquired by Dropbox):
Known Uses in Popular Apps
- [Soundcloud] (https://play.google.com/store/apps/details?id=com.soundcloud.android)
- [Dropbox Paper] (https://play.google.com/store/apps/details?id=com.dropbox.paper)
- [Snaptee] (https://play.google.com/store/apps/details?id=co.snaptee.android)
If you are using the library and you would like to have your app listed, simply let us know.
Importing the Library
Simply add the following dependency to your build.gradle file to use the latest version:
dependencies {
repositories {
mavenCentral()
}
compile 'com.sothree.slidinguppanel:library:3.4.0'
}
Usage
- Include
com.sothree.slidinguppanel.SlidingUpPanelLayoutas the root element in your activity layout. - The layout must have
gravityset to eithertoporbottom. - Make sure that it has two children. The first child is your main layout. The second child is your layout for the sliding up panel.
- The main layout should have the width and the height set to
match_parent. - The sliding layout should have the width set to
match_parentand the height set to eithermatch_parent,wrap_contentor the max desireable height. If you would like to define the height as the percetange of the screen, set it tomatch_parentand also define alayout_weightattribute for the sliding view. - By default, the whole panel will act as a drag region and will intercept clicks and drag events. You can restrict the drag area to a specific view by using the
setDragViewmethod orumanoDragViewattribute.
For more information, please refer to the sample code.
<com.sothree.slidinguppanel.SlidingUpPanelLayout
xmlns:sothree="http://schemas.android.com/apk/res-auto"
android:id="@+id/sliding_layout"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:gravity="bottom"
sothree:umanoPanelHeight="68dp"
sothree:umanoShadowHeight="4dp">
<TextView
android:layout_width="match_parent"
android:layout_height="match_parent"
android:gravity="center"
android:text="Main Content"
android:textSize="16sp" />
<TextView
android:layout_width="match_parent"
android:layout_height="match_parent"
android:gravity="center|top"
android:text="The Awesome Sliding Up Panel"
android:textSize="16sp" />
</com.sothree.slidinguppanel.SlidingUpPanelLayout>
For smooth interaction with the ActionBar, make sure that windowActionBarOverlay is set to true in your styles:
<style name="AppTheme">
<item name="android:windowActionBarOverlay">true</item>
</style>
However, in this case you would likely want to add a top margin to your main layout of ?android:attr/actionBarSize or ?attr/actionBarSize to support older API versions.
Caveats, Additional Features and Customization
- If you are using a custom
umanoDragView, the panel will pass through the click events to the main layout. Make your second layoutclickableto prevent this. - You can change the panel height by using the
setPanelHeightmethod orumanoPanelHeightattribute. - If you would like to hide the shadow above the sliding panel, set
shadowHeightattribute to 0. - Use
setEnabled(false)to completely disable the sliding panel (including touch and programmatic sliding) - Use
setTouchEnabled(false)to disables panel's touch responsiveness (drag and click), you can still control the panel programatically - Use
getPanelStateto get the current panel state - Use
setPanelStateto set the current panel state - You can add parallax to the main view by setting
umanoParallaxOffsetattribute (see demo for the example). - You can set a anchor point in the middle of the screen using
setAnchorPointto allow an intermediate expanded state for the panel (similar to Google Maps). - You can set a
PanelSlideListenerto monitor events about sliding panes. - You can also make the panel slide from the top by changing the
layout_gravityattribute of the layout totop. - You can provide a scroll interpolator for the panel movement by setting
umanoScrollInterpolatorattribute. For instance, if you want a bounce or overshoot effect for the panel. - By default, the panel pushes up the main content. You can make it overlay the main content by using
setOverlayedmethod orumanoOverlayattribute. This is useful if you would like to make the sliding layout semi-transparent. You can also setumanoClipPanelto false to make the panel transparent in non-overlay mode. - By default, the main content is dimmed as the panel slides up. You can change the dim color by changing
umanoFadeColor. Set it to"@android:color/transparent"to remove dimming completely.
Scrollable Sliding Views
If you have a scrollable view inside of the sliding panel, make sure to set umanoScrollableView attribute on the panel to supported nested scrolling. The panel supports ListView, ScrollView and RecyclerView out of the box, but you can add support for any type of a scrollable view by setting a custom ScrollableViewHelper. Here is an example for NestedScrollView
public class NestedScrollableViewHelper extends ScrollableViewHelper {
public int getScrollableViewScrollPosition(View scrollableView, boolean isSlidingUp) {
if (mScrollableView instanceof NestedScrollView) {
if(isSlidingUp){
return mScrollableView.getScrollY();
} else {
NestedScrollView nsv = ((NestedScrollView) mScrollableView);
View child = nsv.getChildAt(0);
return (child.getBottom() - (nsv.getHeight() + nsv.getScrollY()));
}
} else {
return 0;
}
}
}
Once you define your helper, you can set it using setScrollableViewHelper on the sliding panel.
Implementation
This library was initially based on the opened-sourced SlidingPaneLayout component from the r13 of the Android Support Library. Thanks Android team!
Requirements
Tested on Android 2.2+
Other Contributors
- Nov 23, 15 - @kiyeonk - umanoScrollInterpolator support
- Jan 21, 14 - ChaYoung You (@yous) - Slide from the top support
- Aug 20, 13 - @gipi - Android Studio Support
- Jul 24, 13 - Philip Schiffer (@hameno) - Maven Support
- Oct 20, 13 - Irina Preșa (@iriina) - Anchor Support
- Dec 1, 13 - (@youchy) - XML Attributes Support
- Dec 22, 13 - Vladimir Mironov (@MironovNsk) - Custom Expanded Panel Height
If you have an awesome pull request, send it over!
Changelog
- 3.4.0
- Use the latest support library 26 and update the min version to 14.
- Bug fixes
- 3.3.1
- Lots of bug fixes from various pull requests.
- Removed the nineoldandroids dependency. Use ViewCompat instead.
- 3.3.0
- You can now set a
FadeOnClickListener, for when the faded area of the main content is clicked. PanelSlideListenerhas a new format (multiple of them can be set now- Fixed the setTouchEnabled bug
- You can now set a
- 3.2.1
- Add support for
umanoScrollInterpolator - Add support for percentage-based sliding panel height using
layout_weightattribute - Add
ScrollableViewHelperto allow users extend support for new types of scrollable views.
- Add support for
- 3.2.0
- Rename
umanoParalaxOffsettoumanoParallaxOffset - RecyclerView support.
- Rename
- 3.1.0
- Added
umanoScrollableViewto supported nested scrolling in children (only ScrollView and ListView are supported for now)
- Added
- 3.0.0
- Added
umanoprefix for all attributes - Added
clipPanelattribute for supporting transparent panels in non-overlay mode. setEnabled(false)- now completely disables the sliding panel (touch and programmatic sliding)setTouchEnabled(false)- disables panel's touch responsiveness (drag and click), you can still control the panel programaticallygetPanelState- is now the only method to get the current panel statesetPanelState- is now the only method to modify the panel state from code
- Added
- 2.0.2 - Allow
wrap_contentfor sliding view height attribute. Bug fixes. - 2.0.1 - Bug fixes.
- 2.0.0 - Cleaned up various public method calls. Added animated
showPanel/hidePanelmethods. - 1.0.1 - Initial Release
Licence
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or 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.
103 Oct 12, 2022
576 Nov 23, 2022
1.1k Dec 22, 2022
1.5k Jan 2, 2023
918 Dec 4, 2022
462 Nov 14, 2022
970 Jan 6, 2023
3.2k Dec 6, 2022
2.7k Dec 29, 2022
7 Dec 15, 2022
6.1k Dec 29, 2022
483 Nov 25, 2022
654 Dec 2, 2022
31 Dec 20, 2022
224 Nov 25, 2022
1.8k Dec 13, 2022
1.4k Dec 26, 2022
318 Dec 7, 2022