Composable Component

CircularProgressIndicator

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

CircularProgressIndicator social preview

Deprecated

Use the overload that takes gapSize, see LegacyCircularProgressIndicatorSample on how to restore the previous behavior

Source set: Common

Added in 1.5.0-alpha17

Deprecated in 1.5.0-alpha17

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

Added in 1.5.0-alpha17

Deprecated in 1.5.0-alpha17

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

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

Deprecated

Use the overload that takes gapSize

Source set: Common

Added in 1.5.0-alpha17

Deprecated in 1.5.0-alpha17

@Composable
fun CircularProgressIndicator(
    modifier: Modifier = Modifier,
    color: Color = ProgressIndicatorDefaults.circularColor,
    strokeWidth: Dp = ProgressIndicatorDefaults.CircularStrokeWidth,
    trackColor: Color = ProgressIndicatorDefaults.circularIndeterminateTrackColor,
    strokeCap: StrokeCap = ProgressIndicatorDefaults.CircularIndeterminateStrokeCap,
) =
    CircularProgressIndicator(
        modifier = modifier,
        color = color,
        strokeWidth = strokeWidth,
        trackColor = trackColor,
        strokeCap = strokeCap,
        gapSize = 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
Source set: Common

Added in 1.5.0-alpha17

Deprecated in 1.5.0-alpha17

@Composable
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

Deprecated

Use the overload that takes progress as a lambda

Source set: Common

Added in 1.5.0-alpha17

Deprecated in 1.5.0-alpha17

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

Deprecated

Maintained for binary compatibility

Source set: Common

Added in 1.5.0-alpha17

Deprecated in 1.5.0-alpha17

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

Deprecated

Maintained for binary compatibility

Source set: Common

Added in 1.5.0-alpha17

Deprecated in 1.5.0-alpha17

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