Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MohamedRejeb/compose-dnd
Compose DND is a library that allows you to easily add drag and drop functionality to your Jetpack Compose or Compose Multiplatform projects.
https://github.com/MohamedRejeb/compose-dnd
android android-library compose compose-library compose-multiplatform compose-multiplatform-library compose-ui dnd drag drag-and-drop drag-drop draggable jetpack-compose kotlin kotlin-android kotlin-multiplatform
Last synced: 3 months ago
JSON representation
Compose DND is a library that allows you to easily add drag and drop functionality to your Jetpack Compose or Compose Multiplatform projects.
- Host: GitHub
- URL: https://github.com/MohamedRejeb/compose-dnd
- Owner: MohamedRejeb
- License: apache-2.0
- Created: 2023-03-13T13:37:10.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-23T22:31:28.000Z (8 months ago)
- Last Synced: 2024-07-12T21:12:59.388Z (4 months ago)
- Topics: android, android-library, compose, compose-library, compose-multiplatform, compose-multiplatform-library, compose-ui, dnd, drag, drag-and-drop, drag-drop, draggable, jetpack-compose, kotlin, kotlin-android, kotlin-multiplatform
- Language: Kotlin
- Homepage:
- Size: 457 KB
- Stars: 251
- Watchers: 4
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome - Compose DND
- kmp-awesome - Compose DND
README
# Compose Drag And Drop
Compose DND is a library that allows you to easily add drag and drop functionality to your Jetpack Compose or Compose Multiplatform projects.
[](http://kotlinlang.org)
[](https://github.com/MohamedRejeb)
[](https://opensource.org/licenses/Apache-2.0)
[](https://github.com/MohamedRejeb/compose-dnd/actions)
[](https://search.maven.org/search?q=g:%22com.mohamedrejeb.dnd%22%20AND%20a:%compose-dnd%22)
## Installation
[](https://search.maven.org/search?q=g:%22com.mohamedrejeb.dnd%22%20AND%20a:%compose-dnd%22)
Add the following dependency to your module `build.gradle.kts` file:
```kotlin
implementation("com.mohamedrejeb.dnd:compose-dnd:0.2.0")
```
## Usage
### Drag and Drop
To implement drag and drop functionality:
- Create a `DragAndDropState` with `rememberDragAndDropState`.
```kotlin
val dragAndDropState = rememberDragAndDropState()
```
- Add `DragAndDropContainer` composable which will wrap the draggable items.
```kotlin
DragAndDropContainer(
state = dragAndDropState,
) {
}
```
- Add `DraggableItem` composable for each draggable item.
```kotlin
DraggableItem(
state = dragAndDropState,
key = task.id, // Unique key for each draggable item
data = task, // Data to be passed to the drop target
) {
}
```
- Add `Modifier.dropTarget` for each drop target.
```kotlin
Modifier.dropTarget(
state = dragAndDropState,
key = task.id, // Unique key for each drop target
onDrop = { state -> // Data passed from the draggable item
// Handle drop
}
)
```
> For more details, check out the [sample](https://github.com/MohamedRejeb/compose-dnd/tree/main/sample/common/src/commonMain/kotlin)
### Reorder List
To implement reorder list functionality:
- Create a `ReorderState` with `rememberReorderState`.
```kotlin
val reorderState = rememberReorderState()
```
- Add `ReorderContainer` composable which will wrap the reorderable items.
```kotlin
ReorderContainer(
state = reorderState,
) {
}
```
- Add `ReorderableItem` composable for each reorderable item.
```kotlin
ReorderableItem(
state = reorderState,
key = task.id, // Unique key for each reorderable item
data = task, // Data to be passed to the drop target
onDrop = { state -> // Data passed from the draggable item
// Handle drop
}
) {
}
```
The `ReorderableItem` composable is at the same time a `DraggableItem` and a `dropTarget`.
> For more details, check out the [sample](https://github.com/MohamedRejeb/compose-dnd/tree/main/sample/common/src/commonMain/kotlin)
### Enable/Disable Drag and Drop
If you want to enable/disable drag and drop functionality, you can use the `enabled` parameter in the `DragAndDropContainer` and `ReorderContainer` composable.
```kotlin
DragAndDropContainer(
state = dragAndDropState,
enabled = false
) {
}
```
```kotlin
ReorderContainer(
state = reorderState,
enabled = false
) {
}
```
> This will disable the drag and drop functionality for all the draggable items.
If you want to disable drag and drop for a specific item, you can use the `enabled` parameter in the `DraggableItem` and `ReorderableItem` composable.
```kotlin
DraggableItem(
state = dragAndDropState,
key = task.id,
data = task,
enabled = false
) {
}
```
```kotlin
ReorderableItem(
state = reorderState,
key = task.id,
data = task,
onDrop = { state ->
// Handle drop
},
enabled = false
) {
}
```
## Contribution
If you've found an error in this sample, please file an issue.
Feel free to help out by sending a pull request :heart:.
[Code of Conduct](https://github.com/MohamedRejeb/compose-dnd/blob/main/CODE_OF_CONDUCT.md)
## Find this library useful? :heart:
Support it by joining __[stargazers](https://github.com/MohamedRejeb/compose-dnd/stargazers)__ for this repository. :star:
Also, __[follow me](https://github.com/MohamedRejeb)__ on GitHub for more libraries! 🤩
You can always 
# License
```
Copyright 2023 Mohamed Rejeb
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.
```