Glisser-déposer

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Jetpack Compose permet le glisser-déposer avec deux modificateurs:

• dragAndDropSource: spécifie un composable comme point de départ du geste de déplacement.
• dragAndDropTarget: spécifie un composable qui accepte les données supprimées.

Par exemple, pour permettre aux utilisateurs de faire glisser une image dans votre application, créez un composable d'image et ajoutez le modificateur dragAndDropSource. Pour configurer une cible de dépôt, créez un autre composable d'image et ajoutez le modificateur dragAndDropTarget.

Les modificateurs peuvent être appliqués à plusieurs sources et cibles de dépôt.

Les modificateurs permettent aux applications de partager des données entre deux composables ou plus à l'aide de ClipData, qui est interopérable avec les implémentations View.

Spécifier une source pour le déplacement

Pour activer les événements de déplacement dans un composant, ajoutez le modificateur dragAndDropSource. Elle utilise une fonction comme paramètre. Dans cette fonction, utilisez DragAndDropTransferData pour représenter les données transférables. Il peut s'agir d'un URI distant, de données de texte enrichi stockées dans le presse-papiers, d'un fichier local, etc. Toutefois, elles doivent toutes être encapsulées dans un objet ClipData. Fournissez du texte brut, par exemple:

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

Pour permettre à l'action de déplacement de traverser les frontières de l'application, le constructeur DragAndDropTransferData accepte un argument flags. Dans l'exemple suivant, la constante DRAG_FLAG_GLOBAL spécifie que les données peuvent être déplacées d'une application vers une autre:

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

DragAndDropTransferData accepte les indicateurs compatibles avec le système Android View. Consultez la liste des constantes View pour obtenir une liste exhaustive des indicateurs disponibles.

Recevoir les données de dépôt

Attribuez le modificateur dragAndDropTarget à un composable pour lui permettre de recevoir des événements de glisser-déposer. Le modificateur comporte deux paramètres: le premier sert de filtre et spécifie le type de données que le modificateur peut accepter, et le second fournit les données dans un rappel.

Notez que l'instance de rappel doit être mémorisée. L'extrait de code suivant montre comment mémoriser le rappel:

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

L'extrait de code suivant montre comment gérer le texte brut abandonné:

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

La fonction de rappel doit renvoyer true si l'événement est consommé ou false si l'événement est refusé et ne se propage pas au composant parent.

Gérer les événements de glisser-déposer

Ignorez les rappels dans l'interface DragAndDropTarget pour observer quand un événement glisser-déposer commence, se termine, entre ou sort d'un composant afin de contrôler précisément l'interface utilisateur et le comportement de l'application:

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

Ressources supplémentaires

Atelier de programmation: Glisser-déposer dans Compose