Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/afollestad/drag-select-recyclerview
๐ Easy Google Photos style multi-selection for RecyclerViews, powered by Kotlin and AndroidX.
https://github.com/afollestad/drag-select-recyclerview
android androidx drag-selection google-photos recyclerview selection ui ux
Last synced: about 1 month ago
JSON representation
๐ Easy Google Photos style multi-selection for RecyclerViews, powered by Kotlin and AndroidX.
- Host: GitHub
- URL: https://github.com/afollestad/drag-select-recyclerview
- Owner: afollestad
- License: apache-2.0
- Archived: true
- Created: 2015-10-24T04:16:42.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2022-04-13T08:49:33.000Z (over 2 years ago)
- Last Synced: 2024-09-21T21:32:44.186Z (about 2 months ago)
- Topics: android, androidx, drag-selection, google-photos, recyclerview, selection, ui, ux
- Language: Kotlin
- Homepage: https://af.codes
- Size: 28 MB
- Stars: 1,972
- Watchers: 46
- Forks: 232
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- -awesome-android-ui - Drag Select Recycler View - select-recyclerview.gif" width="49%" /> (Index `(light-weight pages)`)
- awesome-android-ui - Drag Select Recycler View - select-recyclerview.gif" width="49%" /> (Index `(light-weight pages)`)
- awesome-github-android-ui - drag-select-recyclerview - ๅฎ็ฐGooglePhotoๆ ทๅผๅค้ๆฉ (RecyclerView)
- awesome-android-ui - Drag Select Recycler View - select-recyclerview.gif" width="49%" /> (Index)
- awesome-kotlin - drag-select-recyclerview - ๐ Easy Google Photos style multi-selection for RecyclerViews, powered by Kotlin and AndroidX. (Libraries)
README
# Drag Select Recycler View
[  ](https://repo1.maven.org/maven2/com/afollestad/drag-select-recyclerview)
[](https://github.com/afollestad/drag-select-recyclerview/actions?query=workflow%3A%22Android+CI%22)
[](https://www.apache.org/licenses/LICENSE-2.0.html)
This library allows you to implement Google Photos style multi-selection in your apps! You start
by long pressing an item in your list, then you drag your finger without letting go to select more.
# Sample
You can [download a sample APK](https://github.com/afollestad/drag-select-recyclerview/raw/master/sample/sample.apk).
---
# Gradle Dependency
The Gradle dependency is available via [jCenter](https://bintray.com/drummer-aidan/maven/material-camera/view).
jCenter is the default Maven repository used by Android Studio.
## Dependency
Add the following to your module's `build.gradle` file:
```Gradle
dependencies {
implementation 'com.afollestad:drag-select-recyclerview:2.4.0'
}
```
---
# Introduction
`DragSelectTouchListener` is the main class of this library.
This library will handle drag interception and auto scroll logic - if you drag to the top of the RecyclerView,
the list will scroll up, and vice versa.
---
# DragSelectTouchListener
### Basics
`DragSelectTouchListener` attaches to your RecyclerViews. It intercepts touch events
when it's active, and reports to a receiver which handles updating UI
```kotlin
val receiver: DragSelectReceiver = // ...
val touchListener = DragSelectTouchListener.create(context, receiver)
```
### Configuration
There are a few things that you can configure, mainly around auto scroll.
```kotlin
DragSelectTouchListener.create(context, adapter) {
// Configure the auto-scroll hotspot
hotspotHeight = resources.getDimensionPixelSize(R.dimen.default_56dp)
hotspotOffsetTop = 0 // default
hotspotOffsetBottom = 0 // default
// Listen for auto scroll start/end
autoScrollListener = { isScrolling -> }
// Or instead of the above...
disableAutoScroll()
// The drag selection mode, RANGE is the default
mode = RANGE
}
```
The auto-scroll hotspot is a invisible section at the top and bottom of your
RecyclerView, when your finger is in one of those sections, auto scroll is
triggered and the list will move up or down until you lift your finger.
If you use `PATH` as the mode instead of `RANGE`, the behavior is a bit different:
Compare it to the GIF at the top.
---
# Interaction
A receiver looks like this:
```kotlin
class MyReceiver : DragSelectReceiver {
override fun setSelected(index: Int, selected: Boolean) {
// do something to mark this index as selected/unselected
if(selected && !selectedIndices.contains(index)) {
selectedIndices.add(index)
} else if(!selected) {
selectedIndices.remove(index)
}
}
override fun isSelected(index: Int): Boolean {
// return true if this index is currently selected
return selectedItems.contains(index)
}
override fun isIndexSelectable(index: Int): Boolean {
// if you return false, this index can't be used with setIsActive()
return true
}
override fun getItemCount(): Int {
// return size of your data set
return 0
}
}
```
In the sample project, our adapter is also our receiver.
To start drag selection, you use `setIsActive`, which should be triggered
from user input such as a long press on a list item.
```kotlin
val recyclerView: RecyclerView = // ...
val receiver: DragSelectReceiver = // ...
val touchListener = DragSelectTouchListener.create(context, receiver)
recyclerView.addOnItemTouchListener(touchListener) // important!!
// true for active = true, 0 is the initial selected index
touchListener.setIsActive(true, 0)
````