Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aclassen/ComposeReorderable
Enables reordering by drag and drop in Jetpack Compose (Desktop) LazyList & LazyGrid.
https://github.com/aclassen/ComposeReorderable
android compose-desktop jetpack-compose
Last synced: about 6 hours ago
JSON representation
Enables reordering by drag and drop in Jetpack Compose (Desktop) LazyList & LazyGrid.
- Host: GitHub
- URL: https://github.com/aclassen/ComposeReorderable
- Owner: aclassen
- License: apache-2.0
- Created: 2021-07-09T22:42:22.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-05T18:23:08.000Z (10 months ago)
- Last Synced: 2024-06-28T03:37:21.876Z (5 months ago)
- Topics: android, compose-desktop, jetpack-compose
- Language: Kotlin
- Homepage:
- Size: 2.37 MB
- Stars: 781
- Watchers: 8
- Forks: 82
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Compose LazyList/Grid reorder
[](https://github.com/aclassen/ComposeReorderable/releases/latest)
A Jetpack Compose (Android + Desktop) modifier enabling reordering by drag and drop in a LazyList and LazyGrid.
## Download
```
dependencies {
implementation("org.burnoutcrew.composereorderable:reorderable:")
}
```
## How to use
- Create a reorderable state by `rememberReorderableLazyListState` for LazyList or `rememberReorderableLazyGridState` for LazyGrid
- Add the `reorderable(state)` modifier to your list/grid
- Inside the list/grid itemscope create a `ReorderableItem(state, key = )` for a keyed lists or `ReorderableItem(state, index = )` for a indexed only list. (Animated items only work with keyed lists)
- Apply the `detectReorderAfterLongPress(state)` or `detectReorder(state)` modifier to the list.
If only a drag handle is needed apply the detect modifier to any child composable inside the item layout.
`ReorderableItem` provides the item dragging state, use this to apply elevation , scale etc.
```kotlin
@Composable
fun VerticalReorderList() {
val data = remember { mutableStateOf(List(100) { "Item $it" }) }
val state = rememberReorderableLazyListState(onMove = { from, to ->
data.value = data.value.toMutableList().apply {
add(to.index, removeAt(from.index))
}
})
LazyColumn(
state = state.listState,
modifier = Modifier
.reorderable(state)
.detectReorderAfterLongPress(state)
) {
items(data.value, { it }) { item ->
ReorderableItem(state, key = item) { isDragging ->
val elevation = animateDpAsState(if (isDragging) 16.dp else 0.dp)
Column(
modifier = Modifier
.shadow(elevation.value)
.background(MaterialTheme.colors.surface)
) {
Text(item)
}
}
}
}
}
```
The item placement and drag cancelled animation can be changed or disabled by `dragCancelledAnimation` and `defaultDraggingModifier`
```kotlin
@Composable
fun VerticalReorderGrid() {
val data = remember { mutableStateOf(List(100) { "Item $it" }) }
val state = rememberReorderableLazyGridState(dragCancelledAnimation = NoDragCancelledAnimation(),
onMove = { from, to ->
data.value = data.value.toMutableList().apply {
add(to.index, removeAt(from.index))
}
})
LazyVerticalGrid(
columns = GridCells.Fixed(4),
state = state.gridState,
modifier = Modifier.reorderable(state)
) {
items(data.value, { it }) { item ->
ReorderableItem(state, key = item, defaultDraggingModifier = Modifier) { isDragging ->
Box(
modifier = Modifier
.aspectRatio(1f)
.background(MaterialTheme.colors.surface)
) {
Text(text = item,
modifier = Modifier.detectReorderAfterLongPress(state)
)
}
}
}
}
}
```
Check out the sample app for different implementation samples.
## Notes
It's a known issue that the first visible item does not animate.
## License
```
Copyright 2022 André Claßen
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
https://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.
```