Start native apps faster with the Composables CLI ->
Compose Component

CircularProgressIndicator

Material Design determinate circular progress indicator Progress indicators express an unspecified wait time or display the duration of a process.

CircularProgressIndicator social preview

CircularProgressIndicator

Source set: Common
@Deprecated(
    message =
        "Use the overload that takes `gapSize`, see " +
            "`LegacyCircularProgressIndicatorSample` on how to restore the previous behavior",
    replaceWith =
        ReplaceWith(
            "CircularProgressIndicator(progress, modifier, color, strokeWidth, trackColor, " +
                "strokeCap, gapSize)"
        ),
    level = DeprecationLevel.HIDDEN,
)
@Composable
public fun CircularProgressIndicator(
    progress: () -> Float,
    modifier: Modifier = Modifier,
    color: Color = ProgressIndicatorDefaults.circularColor,
    strokeWidth: Dp = ProgressIndicatorDefaults.CircularStrokeWidth,
    trackColor: Color = ProgressIndicatorDefaults.circularDeterminateTrackColor,
    strokeCap: StrokeCap = ProgressIndicatorDefaults.CircularDeterminateStrokeCap,
)

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

CircularProgressIndicator

Source set: Common
@Composable
public 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,
)

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

CircularProgressIndicator

Source set: Common
@Deprecated(
    message = "Use the overload that takes `gapSize`",
    replaceWith =
        ReplaceWith(
            "CircularProgressIndicator(modifier, color, strokeWidth, trackColor, strokeCap, " +
                "gapSize)"
        ),
    level = DeprecationLevel.HIDDEN,
)
@Composable
public fun CircularProgressIndicator(
    modifier: Modifier = Modifier,
    color: Color = ProgressIndicatorDefaults.circularColor,
    strokeWidth: Dp = ProgressIndicatorDefaults.CircularStrokeWidth,
    trackColor: Color = ProgressIndicatorDefaults.circularIndeterminateTrackColor,
    strokeCap: StrokeCap = ProgressIndicatorDefaults.CircularIndeterminateStrokeCap,
): Unit

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

CircularProgressIndicator

Source set: Common
@Composable
public fun CircularProgressIndicator(
    modifier: Modifier = Modifier,
    color: Color = ProgressIndicatorDefaults.circularColor,
    strokeWidth: Dp = ProgressIndicatorDefaults.CircularStrokeWidth,
    trackColor: Color = ProgressIndicatorDefaults.circularIndeterminateTrackColor,
    strokeCap: StrokeCap = ProgressIndicatorDefaults.CircularIndeterminateStrokeCap,
    gapSize: Dp = ProgressIndicatorDefaults.CircularIndicatorTrackGapSize,
)

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
gapSize size of the gap between the progress indicator and the track

CircularProgressIndicator

Source set: Common
@Deprecated(
    message = "Use the overload that takes `progress` as a lambda",
    replaceWith =
        ReplaceWith(
            "CircularProgressIndicator(\n" +
                "progress = { progress },\n" +
                "modifier = modifier,\n" +
                "color = color,\n" +
                "strokeWidth = strokeWidth,\n" +
                "trackColor = trackColor,\n" +
                "strokeCap = strokeCap,\n" +
                ")"
        ),
)
@Composable
public fun CircularProgressIndicator(
    progress: Float,
    modifier: Modifier = Modifier,
    color: Color = ProgressIndicatorDefaults.circularColor,
    strokeWidth: Dp = ProgressIndicatorDefaults.CircularStrokeWidth,
    trackColor: Color = ProgressIndicatorDefaults.circularTrackColor,
    strokeCap: StrokeCap = ProgressIndicatorDefaults.CircularDeterminateStrokeCap,
): Unit

CircularProgressIndicator

Source set: Common
@Deprecated("Maintained for binary compatibility", level = DeprecationLevel.HIDDEN)
@Composable
public fun CircularProgressIndicator(
    progress: Float,
    modifier: Modifier = Modifier,
    color: Color = ProgressIndicatorDefaults.circularColor,
    strokeWidth: Dp = ProgressIndicatorDefaults.CircularStrokeWidth,
): Unit

CircularProgressIndicator

Source set: Common
@Deprecated("Maintained for binary compatibility", level = DeprecationLevel.HIDDEN)
@Composable
public fun CircularProgressIndicator(
    modifier: Modifier = Modifier,
    color: Color = ProgressIndicatorDefaults.circularColor,
    strokeWidth: Dp = ProgressIndicatorDefaults.CircularStrokeWidth,
): Unit