This library provides swipe & drag and drop support for RecyclerView. Based on great example from Android-ItemTouchHelper-Demo.
- item click/long press/double tap listener
- background view for swipeable items
- empty view
- undo
- swipe
- long press drag
- manual mode drag
- support for different layout managers
- predefined drag & swipe flags for RecyclerView's layout managers
- DiffUtil feature
To use this library in your android project, just simply add the following dependency into your build.gradle
dependencies {
implementation 'com.thesurix.gesturerecycler:gesture-recycler:1.9.0'
}
// Define your RecyclerView and adapter as usually
val manager = LinearLayoutManager(context)
recyclerView.setHasFixedSize(true)
recyclerView.layoutManager = manager
// Extend GestureAdapter and write your own
// ViewHolder items must extend GestureViewHolder
val adapter = MonthsAdapter(R.layout.linear_item)
adapter.data = months
recyclerView.adapter = adapter
val gestureManager = GestureManager.Builder(recyclerView)
// Enable swipe
.setSwipeEnabled(true)
// Enable long press drag and drop
.setLongPressDragEnabled(true)
// Enable manual drag from the beginning, you need to provide View inside your GestureViewHolder
.setManualDragEnabled(true)
// Use custom gesture flags
// Do not use those methods if you want predefined flags for RecyclerView layout manager
.setSwipeFlags(ItemTouchHelper.LEFT or ItemTouchHelper.RIGHT)
.setDragFlags(ItemTouchHelper.UP or ItemTouchHelper.DOWN)
.build()
<FrameLayout
xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="match_parent">
<!-- Content of the background view (you can use regular layout or ViewStub for better performance)-->
<ViewStub
android:id="@+id/background_view_stub"
android:inflatedId="@+id/background_view"
android:layout="@layout/background_view_layout"
android:layout_width="match_parent"
android:layout_height="match_parent" />
<LinearLayout
android:id="@+id/foreground_view"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:orientation="horizontal">
<!-- Content of the top view -->
</LinearLayout>
</FrameLayout>
// Override foregroundView, backgroundView() variables in ViewHolder to provide top and bottom view
open val foregroundView: View
get() = foregound
open val backgroundView: View?
get() = background
adapter.setDataChangeListener(object : GestureAdapter.OnDataChangeListener<MonthItem> {
override fun onItemRemoved(item: MonthItem, position: Int) {
}
override fun onItemReorder(item: MonthItem, fromPos: Int, toPos: Int) {
}
})
// Support for data animations
adapter.add(month)
adapter.insert(month, 5)
adapter.remove(5)
adapter.swap(2, 5)
// or
adapter.setData(months, diffUtilCallback)
// This will interrupt pending animations
adapter.data = months
// Attach DefaultItemClickListener or implement RecyclerItemTouchListener.ItemClickListener
recyclerView.addOnItemTouchListener(RecyclerItemTouchListener(object : DefaultItemClickListener<MonthItem>() {
override fun onItemClick(item: MonthItem, position: Int): Boolean {
// return true if the event is consumed
return true
}
override fun onItemLongPress(item: MonthItem, position: Int) {
}
override fun onDoubleTap(item: MonthItem, position: Int): Boolean {
// return true if the event is consumed
return true
}
}))
<FrameLayout
xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="match_parent">
<android.support.v7.widget.RecyclerView
android:id="@+id/recycler_view"
android:layout_width="match_parent"
android:layout_height="match_parent"/>
<!-- Define your empty view in layout -->
<TextView
android:id="@+id/empty_view"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:textAppearance="@android:style/TextAppearance.Large"
android:text="No data"/>
</FrameLayout>
// Pass null to disable empty view
val emptyView = view.findViewById(R.id.empty_view)
adapter.setEmptyView(emptyView)
// or use callback
adapter.setEmptyViewVisibilityListener(object : EmptyViewVisibilityListener {
override fun onVisibilityChanged(visible: Boolean) {
// show/hide emptyView with animation
}
})
// Undo last data transaction (add, insert, remove, swipe, reorder)
adapter.undoLast()
// Set undo stack size
adapter.setUndoSize(2)
See examples.
- examples with data binding
- tests
- header/footer
- different layouts for different swipe directions
- proguard?
Copyright 2019 thesurix
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.