README.md

ComposeDragDrop

Android Jetpack Compose DragDrop library

Versions

Install

allprojects {
  repositories {
    //...
    mavenCentral()
  }
}

Add dependencies:

For kts

implementation("cn.tinyhai.compose:dragdrop:latest_version")

For groovy

implementation 'cn.tinyhai.compose:dragdrop:latest_version'

For some reason, my publication can't sync to maven central for now. if you want to try the newest feature, you could import via jitpack snapshot. As follow:

Jitpack

https://jitpack.io/#TinyHai/ComposeDragDrop

Demo

DragDropBox	AnimatedDragDropBox

Usage

Write a DragDropBox and put your content inside it

DragDropBox(/* ... */) {
    // put your content here
}
// or
AnimatedDragDropBox(/* ... */) {
    // put your content here
}

Wrap your @Composable content that you want to make draggable with DragTarget

DragTarget<String>(
    dataToDrop = "dataToDrop",
    dragType = DragType.Immediate, // Specify a dragType for this one
                                   // By default,it will be assigned to the defaultDragType you set earlier
    hiddenOnDragging = true, // if true, content will be hidden when the target is being dragging
    uniqueKey = { // using when hiddenOnDragging is true }
) {
    // put your draggable content here
}

Wrap your @Composable content that you want to make droppable with DropTarget

DropTarget<String>(
    onDrop = {
        // this will be invoked when the data is dropped in this DropTarget
    },
) { isInBound, data ->
    // put your droppable content here
}

After all of above, make sure your content is structured as follows

(Animated)DragDropBox { // the container
    CustomComposable {
        // make sure both DragTarget and DropTarget are inside DragDropBox
        DragTarget<Any> { // or any composable which apply dragTarget Modifier
            // draggable content
        }
        DropTarget<Any>(onDrop = {}) { // or any composable which apply dropTarget Modifier
            // droppable content
        }
    }
}

For more details, you can clone this project and run it by yourself.

Credits

• Drag_and_drop_jetpack_compose inspired and based

License

   Copyright (c) 2023-present ,TinyHai.

   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.