Composable Function

RemoteSegmentedCircularProgressIndicator

Material Design segmented circular progress indicator.

RemoteSegmentedCircularProgressIndicator

Source set: Android
@Composable
public fun RemoteSegmentedCircularProgressIndicator(
    segmentCount: RemoteInt,
    progress: RemoteFloat,
    modifier: RemoteModifier = RemoteModifier,
    enabled: RemoteBoolean = true.rb,
    startAngle: RemoteFloat = RemoteProgressIndicatorDefaults.StartAngle,
    endAngle: RemoteFloat = startAngle,
    colors: RemoteProgressIndicatorColors = RemoteProgressIndicatorDefaults.colors(),
    strokeWidth: RemoteDp = RemoteProgressIndicatorDefaults.DefaultStrokeWidth,
    gapSize: RemoteDp = RemoteProgressIndicatorDefaults.calculateRecommendedGapSize(strokeWidth),
)

Material Design segmented circular progress indicator.

A segmented variant of RemoteCircularProgressIndicator that is divided into equally sized segments. This overload of RemoteSegmentedCircularProgressIndicator fills the segments in order based on progress.

Example of RemoteSegmentedCircularProgressIndicator with progress value:

For an animated progress, see:

Parameters
segmentCount Number of equal segments that the progress indicator should be divided into. Has to be a constant RemoteInt greater than or equal to 1.
progress The 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.
modifier Modifier to be applied to the progress indicator.
enabled Controls the enabled state. When enabled is false, this component will appear visually disabled. Note that the disabled colors are only applied when enabled is a constant.
startAngle The starting position of the progress arc, measured clockwise in degrees from the 3 o'clock position. Defaults to RemoteProgressIndicatorDefaults.StartAngle (top of the screen).
endAngle The ending position of the progress arc, measured clockwise in degrees from the 3 o'clock position. By default equal to startAngle.
colors RemoteProgressIndicatorColors that will be used to resolve the indicator and track color for this progress indicator.
strokeWidth The stroke width for the progress indicator. Defaults to RemoteProgressIndicatorDefaults.DefaultStrokeWidth.
gapSize The size of the gap between segments. The stroke endcaps are not included in this distance.

RemoteSegmentedCircularProgressIndicator

Source set: Android
@Composable
public fun RemoteSegmentedCircularProgressIndicator(
    segmentCount: RemoteInt,
    segmentValue: (segmentIndex: Int) -> RemoteBoolean,
    modifier: RemoteModifier = RemoteModifier,
    enabled: RemoteBoolean = true.rb,
    startAngle: RemoteFloat = RemoteProgressIndicatorDefaults.StartAngle,
    endAngle: RemoteFloat = startAngle,
    colors: RemoteProgressIndicatorColors = RemoteProgressIndicatorDefaults.colors(),
    strokeWidth: RemoteDp = RemoteProgressIndicatorDefaults.DefaultStrokeWidth,
    gapSize: RemoteDp = RemoteProgressIndicatorDefaults.calculateRecommendedGapSize(strokeWidth),
)

Material Design segmented circular progress indicator.

A segmented variant of RemoteCircularProgressIndicator that is divided into equally sized segments. This overload of RemoteSegmentedCircularProgressIndicator allows for each segment to be individually indicated as completed, such as for showing activity for intervals within a longer period.

Example of RemoteSegmentedCircularProgressIndicator where the segments are turned on/off:

Parameters
segmentCount Number of equal segments that the progress indicator should be divided into. Has to be a constant RemoteInt greater than or equal to 1.
segmentValue A function that for each segment index between 0 and segmentCount - 1 returns a RemoteBoolean that is true if this segment should be displayed with the indicator color to show progress, and false if the segment should be displayed with the track color.
modifier Modifier to be applied to the progress indicator.
enabled Controls the enabled state. When enabled is false, this component will appear visually disabled. Note that the disabled colors are only applied when enabled is a constant.
startAngle The starting position of the progress arc, measured clockwise in degrees from the 3 o'clock position. Defaults to RemoteProgressIndicatorDefaults.StartAngle (top of the screen).
endAngle The ending position of the progress arc, measured clockwise in degrees from the 3 o'clock position. By default equal to startAngle.
colors RemoteProgressIndicatorColors that will be used to resolve the indicator and track color for this progress indicator.
strokeWidth The stroke width for the progress indicator. Defaults to RemoteProgressIndicatorDefaults.DefaultStrokeWidth.
gapSize The size of the gap between segments. The stroke endcaps are not included in this distance.

Content updated: