進行状況インジケーター

進行状況インジケーターは、オペレーションのステータスを視覚的に表示します。モーションを使用して、データの読み込みや処理など、プロセスの完了までの進捗状況をユーザーに知らせます。また、完了までの進捗状況に関係なく、処理が進行中であることを示すこともできます。

プログレス インジケーターを使用する可能性がある 3 つのユースケースを考えてみましょう。

  • コンテンツの読み込み: ネットワークからコンテンツを取得している間（ユーザー プロフィールの画像やデータの読み込みなど）。
  • ファイルのアップロード: アップロードにかかる時間についてユーザーにフィードバックを提供します。
  • 処理に時間がかかる: アプリが大量のデータを処理している間は、合計のうちどの程度が完了したかをユーザーに伝えます。

マテリアル デザインには、次の 2 種類の進行状況インジケーターがあります。

  • 確定: 進行状況を正確に表示します。
  • 不確定: 進行状況に関係なく継続的にアニメーション化します。

同様に、進行状況インジケーターは次のいずれかの形式をとることができます。

  • 線形: 左から右に埋まっていく横棒。
  • 円: 円の全周を囲むまでストロークの長さが伸びる円。
線形進行状況インジケーターと円形進行状況インジケーター。
図 1. 2 種類の進行状況インジケーター。

API サーフェス

マテリアル デザインに沿ったプログレス インジケーターを作成するために使用できるコンポーザブルはいくつかありますが、それらのパラメータに大きな違いはありません。注意すべき主なパラメータは次のとおりです。

  • progress: インジケーターに表示される現在の進行状況。0.0～1.0 の範囲の Float を渡します。
  • color: 実際のインジケーターの色。つまり、進行状況を反映するコンポーネントの一部であり、進行状況が完了するとコンポーネント全体を完全に囲む部分です。
  • trackColor: インジケーターが描画されるトラックの色。

確定インジケーター

確定インジケーターは、アクションの完了度を正確に反映します。LinearProgressIndicator または CircularProgressIndicator コンポーザブルのいずれかを使用し、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)
    }
}
ProgressIndicator.kt

読み込みが部分的に完了すると、前の例の線形インジケーターは次のように表示されます。

同様に、円形のインジケーターは次のように表示されます。

不確定形式のインジケーター

不確定インジケーターは、オペレーションの完了までの進捗状況を反映しません。完了の程度を指定せずに、モーションを使用して処理が進行中であることをユーザーに示します。

不確定進行状況インジケーターを作成するには、LinearProgressIndicator または CircularProgressIndicator コンポーザブルを使用しますが、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,
    )
}
ProgressIndicator.kt

インジケーターがアクティブな場合の実装例を次に示します。

以下は、同じ実装の例ですが、CircularProgressIndicator ではなく LinearProgressIndicator を使用しています。

参考情報