进度指示器

进度指示器以可视方式显示操作的状态。它们利用动态效果向用户表明进程的完成度,例如加载或处理数据。它们还可以表示正在进行处理,而无需说明完成度。

请考虑以下三种可能使用进度指示器的用例:

  • 加载内容:从网络获取内容时,例如加载图片或用户资料数据。
  • 文件上传:向用户提供上传可能需要多长时间的反馈。
  • 长时间处理:应用正在处理大量数据时,向用户传达已完成的总量。

在 Material Design 中,有两种类型的进度指示器:

  • 确定性:精确显示已完成的进度。
  • 不确定性:持续动画,不显示具体进度。

同样,进度指示器可以采用以下两种形式之一:

  • 线性:从左到右填充的水平条。
  • 圆形:笔触长度逐渐增加,直到环绕整个圆周。
A linear progress indicator alongside a circular progress indicator.
图 1. 两种类型的进度指示器。

API 接口

虽然有多种可组合项可用于创建符合 Material Design 的进度指示器,但它们的参数差异不大。您应牢记以下关键参数:

  • progress:指示器显示的当前进度。传入介于 0.01.0 之间的 Float 值。
  • color:实际指示器的颜色。即组件中反映进度并在进度完成时完全覆盖组件的部分。
  • trackColor:指示器所绘制的轨道的颜色。

确定性指示器

确定性指示器精确反映操作的完成度。使用 LinearProgressIndicatorCircularProgressIndicator 可组合项,并为 progress 参数传入值。

以下代码段提供了一个相对详细的示例。当用户按下按钮时,应用会显示进度指示器,并启动一个协程,该协程会逐渐增加 progress 的值。这会依次使进度指示器增加。

@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)
    }
}

当加载部分完成时,上例中的线性指示器显示如下:

同样,圆形指示器显示如下:

不确定性指示器

不确定性指示器不反映操作的完成度。相反,它使用动态效果向用户表明处理正在进行中,但未指明任何完成度。

要创建不确定性进度指示器,请使用 LinearProgressIndicatorCircularProgressIndicator 可组合项,但不要传入 progress 的值。以下示例演示了如何通过按钮按下切换不确定性指示器。

@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,
    )
}

以下是指示器处于活动状态时此实现的示例:

以下是相同实现的示例,但使用 LinearProgressIndicator 而非 CircularProgressIndicator

其他资源