Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kroegerama/recycler-swipe-stack
An easy to use helper for RecyclerViews. StackLayoutManager and ItemTouchHelperCallback.
https://github.com/kroegerama/recycler-swipe-stack
Last synced: about 1 month ago
JSON representation
An easy to use helper for RecyclerViews. StackLayoutManager and ItemTouchHelperCallback.
- Host: GitHub
- URL: https://github.com/kroegerama/recycler-swipe-stack
- Owner: kroegerama
- License: apache-2.0
- Created: 2021-02-28T21:06:24.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-04-22T17:23:04.000Z (over 3 years ago)
- Last Synced: 2023-07-01T11:04:07.641Z (over 1 year ago)
- Language: Kotlin
- Size: 3.97 MB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Recycler Swipe Stack
**An easy to use helper for RecyclerViews. StackLayoutManager and ItemTouchHelperCallback.**
---
| Artifact | Version |
|:-|:-:|
| recycler-swipe-stack | [](https://search.maven.org/artifact/com.kroegerama/recycler-swipe-stack) |
```kotlin
implementation("com.kroegerama:recycler-swipe-stack:$VERSION")
```
---
### Preview
### Usage
#### 1. Create your `SwiperConfig`
```kotlin
val config = SwiperConfig(
showCount = 5,
swipeDirections = SwipeDirection.LEFT or SwipeDirection.RIGHT or SwipeDirection.UP,
stackDirection = StackDirection.Down,
itemTranslate = 0.02f,
itemRotation = 15f,
itemScale = .0f
)
```
#### 2. Create a `SwipeListener`
```kotlin
private val listener = object : SwipeListener {
override fun onSwipe(
viewHolder: RecyclerView.ViewHolder,
dX: Float,
dY: Float,
direction: Int
) {
}
override fun onSwiped(viewHolder: RecyclerView.ViewHolder, direction: Int) {
Timber.d("onSwiped($direction)")
//example: remove item from Adapter (and call notifyItemRemoved,
//if your adapter doesn't do it automatically)
itemAdapter.removeAt(viewHolder.bindingAdapterPosition)
}
override fun onSwipeEnd(viewHolder: RecyclerView.ViewHolder) {
Timber.d("onSwipeEnd()")
}
override fun isSwipeAllowed(viewHolder: RecyclerView.ViewHolder) = viewHolder is MyViewHolder
}
```
#### 3. Setup the library
##### 3a Use the helper function
```kotlin
recycler.setupStack(
config,
listener
) {
itemAnimator = DefaultItemAnimator().apply {
addDuration = 200
removeDuration = 200
}
adapter = myAdapter
}
```
##### 3b Or setup the classes yourself
###### Create an `ItemTouchHelper` and a `StackLayoutManager`
```kotlin
val itemTouchHelper = ItemTouchHelper(StackSwipeTouchHelperCallback(listener, config))
val layoutManager = StackLayoutManager(config)
```
###### Setup your `RecyclerView`
```kotlin
recycler.layoutManager = layoutManager
itemTouchHelper.attachToRecyclerView(recycler)
```