RemoteProgressIndicatorDefaults

Artifact: androidx.wear.compose.remote:remote-material3

View Source

Added in 1.0.0-alpha11

object RemoteProgressIndicatorDefaults

---

Contains defaults for Remote Progress Indicators.

Summary

Public functions
RemoteDp	calculateRecommendedGapSize(strokeWidth: RemoteDp) Returns recommended size of the gap based on strokeWidth.
RemoteProgressIndicatorColors	@Composable @RemoteComposable colors() Creates a RemoteProgressIndicatorColors with the default colors.
RemoteProgressIndicatorColors	@Composable @RemoteComposable colors(     indicatorBrush: RemoteBrush?,     trackBrush: RemoteBrush?,     overflowTrackBrush: RemoteBrush?,     disabledIndicatorBrush: RemoteBrush?,     disabledTrackBrush: RemoteBrush?,     disabledOverflowTrackBrush: RemoteBrush? ) Creates a RemoteProgressIndicatorColors with modified brushes.
RemoteProgressIndicatorColors	@Composable @RemoteComposable colors(     indicatorColor: RemoteColor?,     trackColor: RemoteColor?,     overflowTrackColor: RemoteColor?,     disabledIndicatorColor: RemoteColor?,     disabledTrackColor: RemoteColor?,     disabledOverflowTrackColor: RemoteColor? ) Creates a RemoteProgressIndicatorColors with modified colors.
RemoteDp	largeStrokeWidth(screenSize: RemoteDp) Large stroke width for circular progress indicator based on screenSize.
RemoteDp	smallStrokeWidth(screenSize: RemoteDp) Small stroke width for circular progress indicator based on screenSize.

Public properties
RemoteFloat	CurvedIndicatorDotFadeOutFraction Default fraction of dot size below which opacity fade-out begins for RemoteCurvedProgressIndicator.
RemoteFloat	CurvedIndicatorGapAngleDegrees Default gap angle in degrees for RemoteCurvedProgressIndicator.
RemoteDp	CurvedIndicatorPadding Default padding from edge for RemoteCurvedProgressIndicator.
RemoteFloat	CurvedIndicatorStartAngle Default start angle for RemoteCurvedProgressIndicator.
RemoteDp	CurvedIndicatorStrokeWidth Default stroke width for RemoteCurvedProgressIndicator.
RemoteFloat	CurvedIndicatorSweepAngle Default sweep angle for RemoteCurvedProgressIndicator.
RemoteDp	DefaultStrokeWidth Default stroke width for RemoteCircularProgressIndicator.
RemoteDp	IndeterminateStrokeWidth Default stroke width for indeterminate RemoteCircularProgressIndicator.
RemoteFloat	StartAngle Default start angle for RemoteCircularProgressIndicator.

Public functions

calculateRecommendedGapSize

Added in 1.0.0-alpha11

fun calculateRecommendedGapSize(strokeWidth: RemoteDp): RemoteDp

Returns recommended size of the gap based on strokeWidth.

colors

Added in 1.0.0-alpha11

@Composable
@RemoteComposable
fun colors(): RemoteProgressIndicatorColors

Creates a RemoteProgressIndicatorColors with the default colors.

colors

Added in 1.0.0-alpha11

@Composable
@RemoteComposable
fun colors(
    indicatorBrush: RemoteBrush? = null,
    trackBrush: RemoteBrush? = null,
    overflowTrackBrush: RemoteBrush? = null,
    disabledIndicatorBrush: RemoteBrush? = null,
    disabledTrackBrush: RemoteBrush? = null,
    disabledOverflowTrackBrush: RemoteBrush? = null
): RemoteProgressIndicatorColors

Creates a RemoteProgressIndicatorColors with modified brushes.

colors

Added in 1.0.0-alpha11

@Composable
@RemoteComposable
fun colors(
    indicatorColor: RemoteColor? = null,
    trackColor: RemoteColor? = null,
    overflowTrackColor: RemoteColor? = null,
    disabledIndicatorColor: RemoteColor? = null,
    disabledTrackColor: RemoteColor? = null,
    disabledOverflowTrackColor: RemoteColor? = null
): RemoteProgressIndicatorColors

Creates a RemoteProgressIndicatorColors with modified colors.

largeStrokeWidth

Added in 1.0.0-alpha11

fun largeStrokeWidth(screenSize: RemoteDp): RemoteDp

Large stroke width for circular progress indicator based on screenSize.

Parameters
screenSize: RemoteDp	Screen size in RemoteDp used to determine stroke width.

Returns
RemoteDp	8.rdp if screenSize is less than SmallScreenBreakpoint, 12.rdp otherwise.

smallStrokeWidth

Added in 1.0.0-alpha11

fun smallStrokeWidth(screenSize: RemoteDp): RemoteDp

Small stroke width for circular progress indicator based on screenSize.

Parameters
screenSize: RemoteDp	Screen size in RemoteDp used to determine stroke width.

Returns
RemoteDp	5.rdp if screenSize is less than SmallScreenBreakpoint, 8.rdp otherwise.

Public properties

CurvedIndicatorDotFadeOutFraction

Added in 1.0.0-alpha11

val CurvedIndicatorDotFadeOutFraction: RemoteFloat

Default fraction of dot size below which opacity fade-out begins for RemoteCurvedProgressIndicator.

CurvedIndicatorGapAngleDegrees

Added in 1.0.0-alpha11

val CurvedIndicatorGapAngleDegrees: RemoteFloat

Default gap angle in degrees for RemoteCurvedProgressIndicator.

CurvedIndicatorPadding

Added in 1.0.0-alpha11

val CurvedIndicatorPadding: RemoteDp

Default padding from edge for RemoteCurvedProgressIndicator.

CurvedIndicatorStartAngle

Added in 1.0.0-alpha11

val CurvedIndicatorStartAngle: RemoteFloat

Default start angle for RemoteCurvedProgressIndicator.

CurvedIndicatorStrokeWidth

Added in 1.0.0-alpha11

val CurvedIndicatorStrokeWidth: RemoteDp

Default stroke width for RemoteCurvedProgressIndicator.

CurvedIndicatorSweepAngle

Added in 1.0.0-alpha11

val CurvedIndicatorSweepAngle: RemoteFloat

Default sweep angle for RemoteCurvedProgressIndicator.

DefaultStrokeWidth

Added in 1.0.0-alpha11

val DefaultStrokeWidth: RemoteDp

Default stroke width for RemoteCircularProgressIndicator.

IndeterminateStrokeWidth

Added in 1.0.0-alpha11

val IndeterminateStrokeWidth: RemoteDp

Default stroke width for indeterminate RemoteCircularProgressIndicator.

StartAngle

Added in 1.0.0-alpha11

val StartAngle: RemoteFloat

Default start angle for RemoteCircularProgressIndicator.