Hauler
Hauler is a library containing custom layout which enables to easily create swipe to dismiss Activity. Implementation is based on code from project Plaid.
How to use
Activity which is meant to be dismissed must contain HaulerView
as a root view and NestedScrollView
(or other View
what supports nested scroll)
as its child. Make sure your NestedScrollview
's attribute android:fillViewport
is set to true
otherwise it might not behave as
expected:
<com.thefuntasty.hauler.HaulerView
xmlns:android="http://schemas.android.com/apk/res/android"
android:id="@+id/haulerView"
android:layout_width="match_parent"
android:layout_height="match_parent">
<androidx.core.widget.NestedScrollView
android:layout_width="match_parent"
android:layout_height="match_parent"
android:fillViewport="true">
<!-- your layout-->
</androidx.core.widget.NestedScrollView>
</com.thefuntasty.hauler.HaulerView>
Secondly, define translucent floating Theme and assign it to the Activity you want to give dismiss ability:
<style name="AppTheme.Draggable" parent="Theme.AppCompat.Light.NoActionBar">
<item name="android:colorBackgroundCacheHint">@null</item>
<item name="android:windowContentOverlay">@null</item>
<item name="android:windowIsFloating">false</item>
<item name="android:windowIsTranslucent">true</item>
<item name="android:windowNoTitle">true</item>
<item name="android:windowBackground">@color/dark_gray</item>
</style>
<activity
android:name=".draggable.SimpleUsageActivity"
android:theme="@style/AppTheme.Draggable"/>
Set onDragDismissListener
to react properly to user dismiss request. Example implementation might look like this:
override fun onCreate(savedInstanceState: Bundle?) {
// ...
haulerView.setOnDragDismissedListener {
finish() // finish activity when dismissed
}
}
Customization
There are few styleable attributes you might want to use to customize your HaulerView
:
<com.thefuntasty.hauler.HaulerView
android:layout_width="match_parent"
android:layout_height="match_parent"
app:dragDismissDistance="112dp"
app:dragDismissFraction="0.9"
app:dragElasticity="0.7"
app:dragDismissScale="0.95"/>
Attribute name | Type | Default value | Description |
---|---|---|---|
app:dragDismissDistance |
dimen | 100dp | Distance which should be View swiped to consider Activity as dismissed |
app:dragDismissFraction |
float | unspecified | <0;1> - Fraction of View 's height we should reach swiping to consider Activity as dismissed |
app:dragElasticity |
float | 0.8 | <0;1> - Toughness of swipe. Higher value indicates more rigid feeling |
app:dragDismissScale |
float | 0.95 | <0;1> - Scale factor of View while performing swipe action |
app:dragUpEnabled |
boolean | false | Flag indicating if drag up dismiss gesture is enabled |
Attributes dragDismissDistance
and dragDismissFraction
are exclusive. Do not use them together.
Download
build.gradle
:
allprojects {
repositories {
maven { url 'https://jitpack.io' }
}
}
module/build.gradle
:
dependencies {
implementation("com.github.thefuntasty.hauler:library:2.0.0")
// optional dependency with set of Data Binding adapters
implementation("com.github.thefuntasty.hauler:databinding:2.0.0")
}