SwipeLibrary provides extension functions for handling swipe actions in RecyclerView.
You can add Swipe To Delete, Drag and Shift and Swipe to perform like functionalities with just one line of code.
Add this to your project level build.gradle file followed by the respective dependency
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
Add the following dependency in your build.gradle file
dependencies {
implementation 'com.github.Priyansh-Kedia:SwipeLibrary:<latest_version>'
}
SwipeLibrary contains the following functions:
Add swipe to delete RecyclerView's items from the list, which a single line of code.
Use addSwipeToDelete as RecyclerView's extension function, to add this functionality to your RecyclerView. This extension function has two optional parameter.
The first parameter is the list of directions in which swipe should be allowed. The directions can be either TOP, BOTTOM, RIGHT, LEFT. The list of directions can be made like this,
val list = listOf(DIRECTION.LEFT,DIRECTION.RIGHT)If no value is passed for the list, by default, RIGHT is the direction for swipe.
The second parameter is the listener for the interface method. The by default value of this parameter is null. If passed, the activity/fragment should implement
OnSwiped. This method will be called when the RecyclerView item is swiped out, and it returns the position of the element that was swiped.
Implementation of interface method In a notes app, if you wish to delete the note from your database, after it is swiped, then you can used this method to perform the action. The note can be deleted by getting the NOTE using the adapter position inside the list passed to RecyclerView Adapter.
override fun swipeToDelete(adapterPosition: Int, swipeDirection: DIRECTION) {
adapter.removeItem(adapterPosition)
// swipeDirection gives the direction in which the item was swiped
}
The third parameter is an optional parameter, for the Color integer, if the user wants a color in the background when the view is swiped out. This is how the user can pass the Color int as the parameter,
ContextCompat.getColor(this, R.color.colorAccent)
The fourth parameter is an optional parameter, for the second Color integer, if the user wants two colors in the background, the user can pass both Parameter 3 and Parameter 4.
All the optional parameters are null, and thus the simplest implementation is,
SwipeToDeleteKt.addSwipeToDelete(recyclerView, null, null, null, null);
recyclerView.addSwipeToDelete()
The optional parameters can be provided if needed.
Highlight, move and shift items of RecyclerView with just a single line of code. Use addDragToShift as RecyclerView's extension function, to add this functionality to your RecyclerView. This extension has one optional parameter.
The parameter is the listener for the interface method. The by default value for this parameter is null. If passed, the activity/fragment should implement
onDragged. This method will be called when the RecyclerView item is dragged and dropped to some other position, and it returns the two positions that were swapped.
Implementation of interface method :- In a notes app, if you wish to change positions of two notes in your database, after they are swapped, then you can used this method to perform the action. The notes can be swapped by getting the NOTES using the adapter positions inside the list passed to RecyclerView Adapter.
override fun onPositionDragged(positionStart: Int, positionEnd: Int) {
adapter.moveItem(positionStart, positionEnd)
}
All the optional parameters are null, and thus the simplest implementation is,
DragAndDropKt.addDragToShift(recyclerView,null);
recycler.addDragToShift()
The optional parameter can be provided if needed.
Add swipe to perform a custom task on RecyclerView's items from the list, which a single line of code.
Use addSwipeToPerform as RecyclerView's extension function, to add this functionality to your RecyclerView. This extension function has two optional parameter.
The first parameter is the list of directions in which swipe should be allowed. The directions can be either TOP, BOTTOM, RIGHT, LEFT. The list of directions can be made like this,
val list = listOf(DIRECTION.LEFT,DIRECTION.RIGHT)If no value is passed for the list, by default, RIGHT is the direction for swipe.
The second parameter is the listener for the interface method. The by default value of this parameter is null. If passed, the activity/fragment should implement
OnSwipeToPerform. This method will be called when the RecyclerView item is swiped out, and it returns the position of the element that was swiped.
Implementation of interface method In a notes app, if you wish to perform a task when a note is swiped, then you can used this method to perform the action.
override fun swipeToPerform(adapterPosition: Int, swipeDirection: DIRECTION) {
// Perform your task
// swipeDirection gives the direction in which the item was swiped
}
The third parameter is an optional parameter, for the Color integer, if the user wants a color in the background when the view is swiped out. This is how the user can pass the Color int as the parameter,
ContextCompat.getColor(this, R.color.colorAccent)
We have performed deletion for the particular case.
The fourth parameter is an optional parameter, for the second Color integer, if the user wants two colors in the background, the user can pass both Parameter 3 and Parameter 4.
All the optional parameters are null, and thus the simplest implementation is,
SwipeToPerformKt.addSwipeToPerform(recyclerView, null, null, null, null);
recyclerView.addSwipeToPerform()
The optional parameters can be provided if needed.
- Fork the repo
- Create a new branch and make changes
- Push the code to the branch and make a PR! 👍
Copyright 2021 Priyansh Kedia
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.
Support it by joining stargazers for this repository. 🌟