composables/com.google.android.horologist.composables/SegmentedProgressIndicator

SegmentedProgressIndicator

@Composable
fun SegmentedProgressIndicator(trackSegments: List<ProgressIndicatorSegment>, progress: Float, modifier: Modifier = Modifier, startAngle: Float = -90.0f, endAngle: Float = 270.0f, strokeWidth: Dp = ProgressIndicatorDefaults.StrokeWidth, paddingAngle: Float = 0.0f, trackColor: Color = MaterialTheme.colors.onBackground.copy(alpha = 0.1f))

Represents a segmented progress indicator.

Parameters

modifier
trackSegments

A list of ProgressIndicatorSegment definitions, specifying the properties of each segment.

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 0..1.

startAngle

The 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 -90 degrees (top of the screen)

endAngle

The 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 270 degrees.

strokeWidth

The stroke width for the progress indicator.

paddingAngle

The gap to place between segments. Defaults to 0 degrees.

trackColor

The background track color. If a segment specifies trackColor then the segment value takes preference. Defaults to Color.Black