Indicateurs de progression

Les indicateurs de progression indiquent visuellement l'état d'une opération. Ils utilisent le mouvement pour attirer l'attention de l'utilisateur sur le degré d'avancement du processus, par exemple le chargement ou le traitement de données. Elles peuvent également indiquer que le traitement prend sur le site, sans tenir compte de son état d'avancement.

Voici trois cas d'utilisation dans lesquels vous pouvez utiliser un indicateur de progression :

  • Chargement de contenu: lors de la récupération de contenu sur un réseau, par exemple une image ou des données pour un profil utilisateur.
  • Importation de fichier : indiquez à l'utilisateur la durée approximative de l'importation.
  • Traitement long: lorsqu'une application traite une grande quantité de données, indiquer à l’utilisateur combien du total est réalisé.

Dans Material Design, il existe deux types d'indicateurs de progression :

  • Déterminé: affiche l'état exact des progrès réalisés.
  • Indéterminé: s'anime en continu, sans tenir compte de la progression.

De même, un indicateur de progression peut prendre l'une des deux formes suivantes:

  • Linéaire: barre horizontale qui se remplit de gauche à droite.
  • Cercle: cercle dont le trait grandit jusqu'à entourer le cercle sur toute la circonférence du cercle.
Indicateur de progression linéaire à côté d'un indicateur de progression circulaire.
Figure 1. Il s'agit des deux types d'indicateurs de progression.

Surface de l'API

Bien qu'il existe plusieurs composables pour créer des indicateurs de progression conformes à Material Design, leurs paramètres ne diffèrent pas considérablement. Entre les paramètres clés que vous devez garder à l'esprit sont les suivants:

  • progress : progression actuelle affichée par l'indicateur. Transmettre un Float entre 0.0 et 1.0.
  • color : couleur de l'indicateur réel. C'est-à-dire que la partie du qui reflète les progrès et qui englobe entièrement la composante une fois la progression terminée.
  • trackColor : couleur du canal sur lequel l'indicateur est dessiné.

Indicateurs déterminants

Un indicateur déterminé reflète exactement le degré d'achèvement d'une action. Utilisez LinearProgressIndicator ou CircularProgressIndicator et transmettez une valeur pour le paramètre progress.

L'extrait de code suivant fournit un exemple relativement détaillé. Lorsque l'utilisateur appuie sur le bouton, l'application affiche l'indicateur de progression et lance une coroutine qui augmente progressivement la valeur de progress. L'indicateur de progression s'itère alors à la hausse.

@Composable
fun LinearDeterminateIndicator() {
    var currentProgress by remember { mutableStateOf(0f) }
    var loading by remember { mutableStateOf(false) }
    val scope = rememberCoroutineScope() // Create a coroutine scope

    Column(
        verticalArrangement = Arrangement.spacedBy(12.dp),
        horizontalAlignment = Alignment.CenterHorizontally,
        modifier = Modifier.fillMaxWidth()
    ) {
        Button(onClick = {
            loading = true
            scope.launch {
                loadProgress { progress ->
                    currentProgress = progress
                }
                loading = false // Reset loading when the coroutine finishes
            }
        }, enabled = !loading) {
            Text("Start loading")
        }

        if (loading) {
            LinearProgressIndicator(
                progress = { currentProgress },
                modifier = Modifier.fillMaxWidth(),
            )
        }
    }
}

/** Iterate the progress value */
suspend fun loadProgress(updateProgress: (Float) -> Unit) {
    for (i in 1..100) {
        updateProgress(i.toFloat() / 100)
        delay(100)
    }
}
ProgressIndicator.kt

Lorsque le chargement est partiellement terminé, l'indicateur linéaire de l'exemple précédent s'affiche comme suit :

De même, l'indicateur circulaire apparaît comme suit:

Indicateurs indéterminés

Un indicateur indéterminé ne reflète pas le degré d'avancement d'une opération. Il utilise plutôt le mouvement pour indiquer à l'utilisateur que le traitement est en cours, mais sans spécifier de degré d'avancement.

Pour créer un indicateur de progression indéterminé, utilisez LinearProgressIndicator. ou CircularProgressIndicator, mais ne transmettez pas de valeur pour progress L'exemple suivant montre comment activer ou désactiver indicateur indéterminé avec une pression sur un bouton.

@Composable
fun IndeterminateCircularIndicator() {
    var loading by remember { mutableStateOf(false) }

    Button(onClick = { loading = true }, enabled = !loading) {
        Text("Start loading")
    }

    if (!loading) return

    CircularProgressIndicator(
        modifier = Modifier.width(64.dp),
        color = MaterialTheme.colorScheme.secondary,
        trackColor = MaterialTheme.colorScheme.surfaceVariant,
    )
}
ProgressIndicator.kt

Voici un exemple d'implémentation lorsque l'indicateur est actif:

Voici un exemple de la même implémentation, mais avec LinearProgressIndicator au lieu de CircularProgressIndicator.

Ressources supplémentaires