State of Compose 2023 results are in! Click here to learn more

← Back to Wear Material

CircularProgressIndicator

Component
in
Wear Material
. Since 1.0.0

Overview

Code Examples

Determinate <a href="https://material.io/components/progress-indicators#circular-progress-indicators" class="external" target="_blank">Material Design circular progress indicator</a>.

Progress indicators express the proportion of completion of an ongoing task.

Progress Indicator doc(https://developer.android.com/training/wearables/components/progress-indicator) !Progress indicator image(https://developer.android.com/images/reference/androidx/compose/material/circular-progress-indicator.png)

There is no animation between progress values by default, but progress can be animated with the recommended ProgressIndicatorDefaults.ProgressAnimationSpec, as in the following example:

Overloads

CircularProgressIndicator

@Composable
public fun CircularProgressIndicator(
    @FloatRange(from = 0.0, to = 1.0)
    progress: Float,
    modifier: Modifier = Modifier,
    startAngle: Float = 270f,
    endAngle: Float = startAngle,
    indicatorColor: Color = MaterialTheme.colors.primary,
    trackColor: Color = MaterialTheme.colors.onBackground.copy(alpha = 0.1f),
    strokeWidth: Dp = ProgressIndicatorDefaults.StrokeWidth,
)

Parameters

NameDescription
modifierModifier to be applied to the CircularProgressIndicator
progressThe progress of this progress indicator where 0.0 represents no progress and 1.0 represents completion. Values outside of this range are coerced into the range 0..1.
startAngleThe starting position of the progress arc, measured clockwise in degrees (0 to 360) from the 3 o'clock position. For example, 0 and 360 represent 3 o'clock, 90 and 180 represent 6 o'clock and 9 o'clock respectively. Default is 270 degrees (top of the screen)
endAngleThe ending position of the progress arc, measured clockwise in degrees (0 to 360) from the 3 o'clock position. For example, 0 and 360 represent 3 o'clock, 90 and 180 represent 6 o'clock and 9 o'clock respectively. By default equal to startAngle
indicatorColorThe color of the progress indicator bar.
trackColorThe color of the background progress track.
strokeWidthThe stroke width for the progress indicator

CircularProgressIndicator

@Composable
public fun CircularProgressIndicator(
    modifier: Modifier = Modifier,
    startAngle: Float = 270f,
    indicatorColor: Color = MaterialTheme.colors.onBackground,
    trackColor: Color = MaterialTheme.colors.onBackground
        .copy(alpha = 0.3f),
    strokeWidth: Dp = IndeterminateStrokeWidth,
)

Parameters

NameDescription
modifierModifier to be applied to the CircularProgressIndicator
startAngleThe starting position of the progress arc, measured clockwise in degrees (0 to 360) from the 3 o'clock position. For example, 0 and 360 represent 3 o'clock, 90 and 180 represent 6 o'clock and 9 o'clock respectively. Default is 270 degrees (top of the screen)
indicatorColorThe color of the progress indicator bar.
trackColorThe color of the background progress track
strokeWidthThe stroke width for the progress indicator