Créer des modificateurs personnalisés

Compose fournit de nombreux modificateurs pour les comportements courants prêts à l'emploi, mais vous pouvez également créer vos propres modificateurs personnalisés.

Les modificateurs comportent plusieurs parties :

• Fabrique de modificateurs
  • Il s'agit d'une fonction d'extension sur Modifier, qui fournit une API idiomatique pour votre modificateur et permet d'enchaîner les modificateurs. La fabrique de modificateurs produit les éléments de modificateur utilisés par Compose pour modifier votre UI.
• Un élément de modificateur
  • C'est là que vous pouvez implémenter le comportement de votre modificateur.

Il existe plusieurs façons d'implémenter un modificateur personnalisé en fonction de la fonctionnalité requise. Souvent, le moyen le plus simple d'implémenter un modificateur personnalisé consiste à implémenter une fabrique de modificateurs personnalisée qui combine d'autres fabriques de modificateurs déjà définies. Si vous avez besoin d'un comportement plus personnalisé, implémentez l'élément modificateur à l'aide des API Modifier.Node, qui sont de niveau inférieur, mais offrent plus de flexibilité.

Chaîner des modificateurs existants

Il est souvent possible de créer des modificateurs personnalisés à l'aide de modificateurs existants. Par exemple, Modifier.clip() est implémenté à l'aide du modificateur graphicsLayer. Cette stratégie utilise des éléments de modificateur existants, et vous fournissez votre propre fabrique de modificateurs personnalisée.

Avant d'implémenter votre propre modificateur personnalisé, vérifiez si vous pouvez utiliser la même stratégie.

fun Modifier.clip(shape: Shape) = graphicsLayer(shape = shape, clip = true)
CustomModifierSnippets.kt

Ou, si vous constatez que vous répétez souvent le même groupe de modificateurs, vous pouvez les encapsuler dans votre propre modificateur :

fun Modifier.myBackground(color: Color) = padding(16.dp)
    .clip(RoundedCornerShape(8.dp))
    .background(color)
CustomModifierSnippets.kt

Créer un modificateur personnalisé à l'aide d'une fabrique de modificateurs composables

Vous pouvez également créer un modificateur personnalisé à l'aide d'une fonction composable pour transmettre des valeurs à un modificateur existant. C'est ce qu'on appelle une fabrique de modificateurs composables.

L'utilisation d'une fabrique de modificateurs composables pour créer un modificateur vous permet également d'utiliser des API Compose de niveau supérieur, telles que animate*AsState et d'autres API d'animation avec état Compose. Par exemple, l'extrait suivant montre un modificateur qui anime un changement d'alpha lorsqu'il est activé/désactivé :

@Composable
fun Modifier.fade(enable: Boolean): Modifier {
    val alpha by animateFloatAsState(if (enable) 0.5f else 1.0f)
    return this then Modifier.graphicsLayer { this.alpha = alpha }
}
CustomModifierSnippets.kt

Si votre modificateur personnalisé est une méthode pratique pour fournir des valeurs par défaut à partir d'un CompositionLocal, le moyen le plus simple de l'implémenter est d'utiliser une fabrique de modificateurs composables :

@Composable
fun Modifier.fadedBackground(): Modifier {
    val color = LocalContentColor.current
    return this then Modifier.background(color.copy(alpha = 0.5f))
}
CustomModifierSnippets.kt

Cette approche comporte quelques mises en garde, qui sont détaillées dans les sections suivantes.

Les valeurs CompositionLocal sont résolues au niveau du site d'appel de la fabrique de modificateurs.

Lorsque vous créez un modificateur personnalisé à l'aide d'une fabrique de modificateurs composables, les locaux de composition prennent la valeur de l'arborescence de composition où ils sont créés, et non celle où ils sont utilisés. Cela peut entraîner des résultats inattendus. Par exemple, prenons l'exemple de modificateur local de composition mentionné précédemment, implémenté légèrement différemment à l'aide d'une fonction composable :

@Composable
fun Modifier.myBackground(): Modifier {
    val color = LocalContentColor.current
    return this then Modifier.background(color.copy(alpha = 0.5f))
}

@Composable
fun MyScreen() {
    CompositionLocalProvider(LocalContentColor provides Color.Green) {
        // Background modifier created with green background
        val backgroundModifier = Modifier.myBackground()

        // LocalContentColor updated to red
        CompositionLocalProvider(LocalContentColor provides Color.Red) {

            // Box will have green background, not red as expected.
            Box(modifier = backgroundModifier)
        }
    }
}
CustomModifierSnippets.kt

Si ce n'est pas le comportement attendu pour votre modificateur, utilisez plutôt un Modifier.Node personnalisé, car les locaux de composition seront correctement résolus au niveau du site d'utilisation et pourront être hissés en toute sécurité.

Les modificateurs de fonction composable ne sont jamais ignorés

Les modificateurs de fabrique composables ne sont jamais ignorés, car les fonctions composables qui ont des valeurs de retour ne peuvent pas être ignorées. Cela signifie que votre fonction de modificateur sera appelée à chaque recomposition, ce qui peut être coûteux si elle se recompose fréquemment.

Les modificateurs de fonction composable doivent être appelés dans une fonction composable.

Comme toutes les fonctions composables, un modificateur de fabrique composable doit être appelé à partir de la composition. Cela limite l'emplacement où un modificateur peut être hissé, car il ne peut jamais être hissé hors de la composition. En comparaison, les fabriques de modificateurs non composables peuvent être hissées hors des fonctions composables pour faciliter la réutilisation et améliorer les performances :

val extractedModifier = Modifier.background(Color.Red) // Hoisted to save allocations

@Composable
fun Modifier.composableModifier(): Modifier {
    val color = LocalContentColor.current.copy(alpha = 0.5f)
    return this then Modifier.background(color)
}

@Composable
fun MyComposable() {
    val composedModifier = Modifier.composableModifier() // Cannot be extracted any higher
}
CustomModifierSnippets.kt

Implémenter un comportement de modificateur personnalisé à l'aide de Modifier.Node

Modifier.Node est une API de niveau inférieur permettant de créer des modificateurs dans Compose. Il s'agit de la même API que celle dans laquelle Compose implémente ses propres modificateurs. C'est le moyen le plus performant de créer des modificateurs personnalisés.

Implémenter un modificateur personnalisé à l'aide de Modifier.Node

L'implémentation d'un modificateur personnalisé à l'aide de Modifier.Node comprend trois parties :

• Implémentation Modifier.Node qui contient la logique et l'état de votre modificateur.
• Un ModifierNodeElement qui crée et met à jour les instances de nœuds de modificateur.
• Fabrique de modificateurs facultative, comme indiqué précédemment.

Les classes ModifierNodeElement sont sans état et de nouvelles instances sont allouées à chaque recomposition, tandis que les classes Modifier.Node peuvent être avec état et survivront à plusieurs recompositions, et peuvent même être réutilisées.

La section suivante décrit chaque partie et montre un exemple de création d'un modificateur personnalisé pour dessiner un cercle.

Modifier.Node

L'implémentation Modifier.Node (CircleNode dans cet exemple) implémente la fonctionnalité de votre modificateur personnalisé.

// Modifier.Node
private class CircleNode(var color: Color) : DrawModifierNode, Modifier.Node() {
    override fun ContentDrawScope.draw() {
        drawCircle(color)
    }
}
CustomModifierSnippets.kt

Dans cet exemple, le cercle est dessiné avec la couleur transmise à la fonction du modificateur.

Un nœud implémente Modifier.Node ainsi que zéro ou plusieurs types de nœuds. Il existe différents types de nœuds en fonction de la fonctionnalité requise par votre modificateur. L'exemple précédent doit pouvoir dessiner. Il implémente donc DrawModifierNode, ce qui lui permet de remplacer la méthode de dessin.

Voici les types disponibles :

Les nœuds sont automatiquement invalidés lorsque la mise à jour est appelée sur leur élément correspondant. Comme notre exemple est un DrawModifierNode, chaque fois que la mise à jour de l'heure est appelée sur l'élément, le nœud déclenche un redessin et sa couleur est correctement mise à jour. Il est possible de désactiver l'invalidation automatique, comme indiqué dans la section Désactiver l'invalidation automatique des nœuds.

ModifierNodeElement

ModifierNodeElement est une classe immuable qui contient les données permettant de créer ou de mettre à jour votre modificateur personnalisé :

// ModifierNodeElement
private data class CircleElement(val color: Color) : ModifierNodeElement<CircleNode>() {
    override fun create() = CircleNode(color)

    override fun update(node: CircleNode) {
        node.color = color
    }
}
CustomModifierSnippets.kt

Les implémentations ModifierNodeElement doivent remplacer les méthodes suivantes :

1. create : fonction qui instancie votre nœud de modificateur. Cette méthode est appelée pour créer le nœud lorsque votre modificateur est appliqué pour la première fois. En général, cela revient à construire le nœud et à le configurer avec les paramètres qui ont été transmis à la fabrique de modificateurs.
2. update : cette fonction est appelée chaque fois que ce modificateur est fourni au même emplacement que celui où ce nœud existe déjà, mais qu'une propriété a changé. Cela est déterminé par la méthode equals de la classe. Le nœud de modificateur créé précédemment est envoyé en tant que paramètre à l'appel update. À ce stade, vous devez mettre à jour les propriétés des nœuds pour qu'elles correspondent aux paramètres modifiés. La possibilité de réutiliser les nœuds de cette manière est essentielle pour les gains de performances apportés par Modifier.Node. Par conséquent, vous devez mettre à jour le nœud existant au lieu d'en créer un dans la méthode update. Dans notre exemple de cercle, la couleur du nœud est mise à jour.

De plus, les implémentations ModifierNodeElement doivent également implémenter equals et hashCode. update ne sera appelé que si une comparaison d'égalité avec l'élément précédent renvoie "false".

L'exemple précédent utilise une classe de données pour y parvenir. Ces méthodes permettent de vérifier si un nœud doit être mis à jour ou non. Si votre élément possède des propriétés qui ne contribuent pas à la mise à jour d'un nœud ou si vous souhaitez éviter les classes de données pour des raisons de compatibilité binaire, vous pouvez implémenter manuellement equals et hashCode, par exemple l'élément de modificateur de marge intérieure.

Modifier factory

Il s'agit de la surface de l'API publique de votre modificateur. La plupart des implémentations créent l'élément de modificateur et l'ajoutent à la chaîne de modificateurs :

// Modifier factory
fun Modifier.circle(color: Color) = this then CircleElement(color)
CustomModifierSnippets.kt

Exemple complet

Ces trois parties se combinent pour créer le modificateur personnalisé permettant de dessiner un cercle à l'aide des API Modifier.Node :

// Modifier factory
fun Modifier.circle(color: Color) = this then CircleElement(color)

// ModifierNodeElement
private data class CircleElement(val color: Color) : ModifierNodeElement<CircleNode>() {
    override fun create() = CircleNode(color)

    override fun update(node: CircleNode) {
        node.color = color
    }
}

// Modifier.Node
private class CircleNode(var color: Color) : DrawModifierNode, Modifier.Node() {
    override fun ContentDrawScope.draw() {
        drawCircle(color)
    }
}
CustomModifierSnippets.kt

Situations courantes utilisant Modifier.Node

Lorsque vous créez des modificateurs personnalisés avec Modifier.Node, voici quelques situations courantes que vous pouvez rencontrer.

Aucun paramètre

Si votre modificateur n'a pas de paramètres, il n'a jamais besoin d'être mis à jour et, de plus, n'a pas besoin d'être une classe de données. Voici un exemple d'implémentation d'un modificateur qui applique une marge intérieure fixe à un composable :

fun Modifier.fixedPadding() = this then FixedPaddingElement

data object FixedPaddingElement : ModifierNodeElement<FixedPaddingNode>() {
    override fun create() = FixedPaddingNode()
    override fun update(node: FixedPaddingNode) {}
}

class FixedPaddingNode : LayoutModifierNode, Modifier.Node() {
    private val PADDING = 16.dp

    override fun MeasureScope.measure(
        measurable: Measurable,
        constraints: Constraints
    ): MeasureResult {
        val paddingPx = PADDING.roundToPx()
        val horizontal = paddingPx * 2
        val vertical = paddingPx * 2

        val placeable = measurable.measure(constraints.offset(-horizontal, -vertical))

        val width = constraints.constrainWidth(placeable.width + horizontal)
        val height = constraints.constrainHeight(placeable.height + vertical)
        return layout(width, height) {
            placeable.place(paddingPx, paddingPx)
        }
    }
}
CustomModifierSnippets.kt

CompositionLocals de référence

Les modificateurs Modifier.Node n'observent pas automatiquement les modifications apportées aux objets d'état Compose, comme CompositionLocal. L'avantage des modificateurs Modifier.Node par rapport à ceux qui sont simplement créés avec une fabrique de composables est qu'ils peuvent lire la valeur du local de composition à partir de l'endroit où le modificateur est utilisé dans votre arborescence d'UI, et non à l'endroit où il est alloué, à l'aide de currentValueOf.

Toutefois, les instances de nœud de modificateur n'observent pas automatiquement les changements d'état. Pour réagir automatiquement à la modification d'une composition locale, vous pouvez lire sa valeur actuelle dans une portée :

• DrawModifierNode : ContentDrawScope
• LayoutModifierNode : MeasureScope & IntrinsicMeasureScope
• SemanticsModifierNode : SemanticsPropertyReceiver

Cet exemple observe la valeur de LocalContentColor pour dessiner un arrière-plan en fonction de sa couleur. Comme ContentDrawScope observe les modifications apportées aux instantanés, il redessine automatiquement l'écran lorsque la valeur de LocalContentColor change :

class BackgroundColorConsumerNode :
    Modifier.Node(),
    DrawModifierNode,
    CompositionLocalConsumerModifierNode {
    override fun ContentDrawScope.draw() {
        val currentColor = currentValueOf(LocalContentColor)
        drawRect(color = currentColor)
        drawContent()
    }
}
CustomModifierSnippets.kt

Pour réagir aux changements d'état en dehors d'une portée et mettre à jour automatiquement votre modificateur, utilisez un ObserverModifierNode.

Par exemple, Modifier.scrollable utilise cette technique pour observer les modifications apportées à LocalDensity. Voici un exemple simplifié :

class ScrollableNode :
    Modifier.Node(),
    ObserverModifierNode,
    CompositionLocalConsumerModifierNode {

    // Place holder fling behavior, we'll initialize it when the density is available.
    val defaultFlingBehavior = DefaultFlingBehavior(splineBasedDecay(UnityDensity))

    override fun onAttach() {
        updateDefaultFlingBehavior()
        observeReads { currentValueOf(LocalDensity) } // monitor change in Density
    }

    override fun onObservedReadsChanged() {
        // if density changes, update the default fling behavior.
        updateDefaultFlingBehavior()
    }

    private fun updateDefaultFlingBehavior() {
        val density = currentValueOf(LocalDensity)
        defaultFlingBehavior.flingDecay = splineBasedDecay(density)
    }
}
CustomModifierSnippets.kt

Animer un modificateur

Les implémentations Modifier.Node ont accès à un coroutineScope. Cela permet d'utiliser les API Compose Animatable. Par exemple, cet extrait modifie le CircleNode affiché précédemment pour qu'il s'affiche et disparaisse de manière répétée :

class CircleNode(var color: Color) : Modifier.Node(), DrawModifierNode {
    private lateinit var alpha: Animatable<Float, AnimationVector1D>

    override fun ContentDrawScope.draw() {
        drawCircle(color = color, alpha = alpha.value)
        drawContent()
    }

    override fun onAttach() {
        alpha = Animatable(1f)
        coroutineScope.launch {
            alpha.animateTo(
                0f,
                infiniteRepeatable(tween(1000), RepeatMode.Reverse)
            ) {
            }
        }
    }
}
CustomModifierSnippets.kt

Partager l'état entre les modificateurs à l'aide de la délégation

Les modificateurs Modifier.Node peuvent déléguer à d'autres nœuds. Il existe de nombreux cas d'utilisation, comme l'extraction d'implémentations courantes dans différents modificateurs, mais il peut également être utilisé pour partager un état commun entre les modificateurs.

Par exemple, une implémentation de base d'un nœud de modificateur cliquable qui partage des données d'interaction :

class ClickableNode : DelegatingNode() {
    val interactionData = InteractionData()
    val focusableNode = delegate(
        FocusableNode(interactionData)
    )
    val indicationNode = delegate(
        IndicationNode(interactionData)
    )
}
CustomModifierSnippets.kt

Désactiver l'invalidation automatique des nœuds

Les nœuds Modifier.Node sont automatiquement invalidés lorsque leurs appels ModifierNodeElement correspondants sont mis à jour. Pour les modificateurs complexes, vous pouvez désactiver ce comportement afin de contrôler plus précisément le moment où votre modificateur invalide les phases.

Ceci est particulièrement utile si votre modificateur personnalisé modifie à la fois la mise en page et le dessin. Si vous désactivez l'invalidation automatique, vous pouvez simplement invalider le dessin lorsque seules les propriétés liées au dessin, telles que color, changent. Cela évite d'invalider la mise en page et peut améliorer les performances de votre modificateur.

Un exemple hypothétique est présenté ci-dessous avec un modificateur dont les propriétés sont des lambdas color, size et onClick. Ce modificateur n'invalide que ce qui est nécessaire, en évitant toute invalidation inutile :

class SampleInvalidatingNode(
    var color: Color,
    var size: IntSize,
    var onClick: () -> Unit
) : DelegatingNode(), LayoutModifierNode, DrawModifierNode {
    override val shouldAutoInvalidate: Boolean
        get() = false

    private val clickableNode = delegate(
        ClickablePointerInputNode(onClick)
    )

    fun update(color: Color, size: IntSize, onClick: () -> Unit) {
        if (this.color != color) {
            this.color = color
            // Only invalidate draw when color changes
            invalidateDraw()
        }

        if (this.size != size) {
            this.size = size
            // Only invalidate layout when size changes
            invalidateMeasurement()
        }

        // If only onClick changes, we don't need to invalidate anything
        clickableNode.update(onClick)
    }

    override fun ContentDrawScope.draw() {
        drawRect(color)
    }

    override fun MeasureScope.measure(
        measurable: Measurable,
        constraints: Constraints
    ): MeasureResult {
        val size = constraints.constrain(size)
        val placeable = measurable.measure(constraints)
        return layout(size.width, size.height) {
            placeable.place(0, 0)
        }
    }
}
CustomModifierSnippets.kt