Перетащите

Jetpack Compose поддерживает функцию перетаскивания с двумя модификаторами:

  • dragAndDropSource : указывает компонуемый объект в качестве начальной точки жеста перетаскивания.
  • dragAndDropTarget : указывает компонуемый объект, который принимает перетаскиваемые данные.

Например, чтобы пользователи могли перетаскивать изображение в вашем приложении, создайте изображение, компонуемое и добавьте модификатор dragAndDropSource . Чтобы настроить цель перетаскивания, создайте еще одно изображение, компонуемое и добавьте модификатор dragAndDropTarget .

Модификаторы можно применять к нескольким источникам перетаскивания и нескольким целям перетаскивания.

Модификаторы позволяют приложениям обмениваться данными между двумя или более компонуемыми объектами с помощью ClipData , который совместим с реализациями View .

Укажите источник перетаскивания

Чтобы включить события перетаскивания внутри компонента, добавьте модификатор dragAndDropSource . Он принимает функцию в качестве параметра. Внутри этой функции используйте DragAndDropTransferData для представления передаваемых данных. Данные могут быть удаленным URI, данными форматированного текста в буфере обмена, локальным файлом или чем-то еще, но все они должны быть обернуты в объект ClipData . Укажите простой текст, например, следующим образом: 

Modifier.dragAndDropSource { _ ->
    DragAndDropTransferData(
        ClipData.newPlainText(
            "image Url", url
        )
    )
}
DragAndDropSnippets.kt

Чтобы разрешить действию перетаскивания пересекать границы приложения, конструктор DragAndDropTransferData принимает аргумент flags . В следующем примере константа DRAG_FLAG_GLOBAL указывает, что данные можно перетаскивать из одного приложения в другое: 

Modifier.dragAndDropSource { _ ->
    DragAndDropTransferData(
        ClipData.newPlainText(
            "image Url", url
        ),
        flags = View.DRAG_FLAG_GLOBAL
    )
}
DragAndDropSnippets.kt

DragAndDropTransferData принимает флаги, поддерживаемые системой Android View. Полный список доступных флагов см. в списке констант View .

Получение данных о сбросе

Назначьте модификатор dragAndDropTarget компонуемому, чтобы компонуемый мог получать события перетаскивания. Модификатор имеет два параметра: первый действует как фильтр и указывает тип данных, которые модификатор может принимать, а второй доставляет данные в обратном вызове.

Обратите внимание, что экземпляр обратного вызова должен быть запомнен . Следующий фрагмент показывает, как запомнить обратный вызов: 

val callback = remember {
    object : DragAndDropTarget {
        override fun onDrop(event: DragAndDropEvent): Boolean {
            // Parse received data
            return true
        }
    }
}
DragAndDropSnippets.kt

Чтобы принимать данные из других приложений, используйте requestDragAndDropPermission , чтобы включить прием, и отпустите его после завершения: 

val externalAppCallback = remember {
    object : DragAndDropTarget {
        override fun onDrop(event: DragAndDropEvent): Boolean {
            val permission =
                activity.requestDragAndDropPermissions(event.toAndroidDragEvent())
            // Parse received data
            permission?.release()
            return true
        }
    }
}
DragAndDropSnippets.kt

Важно помнить, что DragAndDropEvent , возвращаемый методом обратного вызова Compose, отличается от ожидаемого методом requestDragAndDropPermission , поэтому необходимо вызвать функцию расширения toAndroidDragEvent() для параметра, прежде чем передавать его в запрос разрешения.

В следующем фрагменте показано, как обрабатывать перетаскиваемый простой текст: 

Modifier.dragAndDropTarget(
    shouldStartDragAndDrop = { event ->
        event.mimeTypes().contains(ClipDescription.MIMETYPE_TEXT_PLAIN)
    }, target = callback // or externalAppCallback
)
DragAndDropSnippets.kt

Функция обратного вызова должна возвращать true если событие обработано, или false если событие отклонено и не распространяется на родительский компонент.

Обработка событий перетаскивания

Переопределите обратные вызовы в интерфейсе DragAndDropTarget , чтобы отслеживать, когда событие перетаскивания начинается, заканчивается или входит в компонент или выходит из него, для точного управления пользовательским интерфейсом и поведением приложения: 

object : DragAndDropTarget {
    override fun onStarted(event: DragAndDropEvent) {
        // When the drag event starts
    }

    override fun onEntered(event: DragAndDropEvent) {
        // When the dragged object enters the target surface
    }

    override fun onEnded(event: DragAndDropEvent) {
        // When the drag event stops
    }

    override fun onExited(event: DragAndDropEvent) {
        // When the dragged object exits the target surface
    }

    override fun onDrop(event: DragAndDropEvent): Boolean = true
}
DragAndDropSnippets.kt

Дополнительные ресурсы

Codelab: Перетаскивание в Compose