Compose Multiplatform Material3/androidx.compose.material3/CircularProgressIndicator

CircularProgressIndicator

@Composable

fun CircularProgressIndicator(progress: () -> Float, modifier: Modifier = Modifier, color: Color = ProgressIndicatorDefaults.circularColor, strokeWidth: Dp = ProgressIndicatorDefaults.CircularStrokeWidth, trackColor: Color = ProgressIndicatorDefaults.circularDeterminateTrackColor, strokeCap: StrokeCap = ProgressIndicatorDefaults.CircularDeterminateStrokeCap, gapSize: Dp = ProgressIndicatorDefaults.CircularIndicatorTrackGapSize)

Determinate Material Design circular progress indicator.

Progress indicators express an unspecified wait time or display the duration of a process.

By default there is no animation between progress values. You can use ProgressIndicatorDefaults.ProgressAnimationSpec as the default recommended AnimationSpec when animating progress, such as in the following example:

Parameters

progress

the progress of this progress indicator, where 0.0 represents no progress and 1.0 represents full progress. Values outside of this range are coerced into the range.

modifier

the Modifier to be applied to this progress indicator

color

color of this progress indicator

strokeWidth

stroke width of this progress indicator

trackColor

color of the track behind the indicator, visible when the progress has not reached the area of the overall indicator yet

strokeCap

stroke cap to use for the ends of this progress indicator

gapSize

size of the gap between the progress indicator and the track

Samples

androidx.compose.material3.samples.CircularProgressIndicatorSample

@Composable

fun CircularProgressIndicator(modifier: Modifier = Modifier, color: Color = ProgressIndicatorDefaults.circularColor, strokeWidth: Dp = ProgressIndicatorDefaults.CircularStrokeWidth, trackColor: Color = ProgressIndicatorDefaults.circularIndeterminateTrackColor, strokeCap: StrokeCap = ProgressIndicatorDefaults.CircularIndeterminateStrokeCap)

Indeterminate Material Design circular progress indicator.

Progress indicators express an unspecified wait time or display the duration of a process.

Parameters

modifier

the Modifier to be applied to this progress indicator

color

color of this progress indicator

strokeWidth

stroke width of this progress indicator

trackColor

color of the track behind the indicator, visible when the progress has not reached the area of the overall indicator yet

strokeCap

stroke cap to use for the ends of this progress indicator

Samples

androidx.compose.material3.samples.IndeterminateCircularProgressIndicatorSample

@Composable

fun ~~CircularProgressIndicator~~(progress: Float, modifier: Modifier = Modifier, color: Color = ProgressIndicatorDefaults.circularColor, strokeWidth: Dp = ProgressIndicatorDefaults.CircularStrokeWidth, trackColor: Color = ProgressIndicatorDefaults.circularTrackColor, strokeCap: StrokeCap = ProgressIndicatorDefaults.CircularDeterminateStrokeCap)

Deprecated

Use the overload that takes `progress` as a lambda

Replace with

CircularProgressIndicator(
progress = { progress },
modifier = modifier,
color = color,
strokeWidth = strokeWidth,
trackColor = trackColor,
strokeCap = strokeCap,
)