RemoteProgressIndicatorDefaults API Reference in remote-material3

Contains defaults for Remote Progress Indicators.

Source set: Android

public object RemoteProgressIndicatorDefaults

Contains defaults for Remote Progress Indicators.

Properties

IndeterminateStrokeWidth

Source set: Android

public val IndeterminateStrokeWidth: RemoteDp = 3.rdp

Default stroke width for indeterminate RemoteCircularProgressIndicator.

DefaultStrokeWidth

Source set: Android

public val DefaultStrokeWidth: RemoteDp = 12.rdp

Default stroke width for RemoteCircularProgressIndicator.

StartAngle

Source set: Android

public val StartAngle: RemoteFloat = 270f.rf

Default start angle for RemoteCircularProgressIndicator.

CurvedIndicatorStartAngle

Source set: Android

public val CurvedIndicatorStartAngle: RemoteFloat = 135f.rf

Default start angle for RemoteCurvedProgressIndicator.

CurvedIndicatorSweepAngle

Source set: Android

public val CurvedIndicatorSweepAngle: RemoteFloat = 90f.rf

Default sweep angle for RemoteCurvedProgressIndicator.

CurvedIndicatorStrokeWidth

Source set: Android

public val CurvedIndicatorStrokeWidth: RemoteDp = 8.rdp

Default stroke width for RemoteCurvedProgressIndicator.

CurvedIndicatorPadding

Source set: Android

public val CurvedIndicatorPadding: RemoteDp = 2.rdp

Default padding from edge for RemoteCurvedProgressIndicator.

CurvedIndicatorGapAngleDegrees

Source set: Android

public val CurvedIndicatorGapAngleDegrees: RemoteFloat = 2f.rf

Default gap angle in degrees for RemoteCurvedProgressIndicator.

CurvedIndicatorDotFadeOutFraction

Source set: Android

public val CurvedIndicatorDotFadeOutFraction: RemoteFloat = 0.5f.rf

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

Functions

largeStrokeWidth

Source set: Android

public fun largeStrokeWidth(screenSize: RemoteDp): RemoteDp

Large stroke width for circular progress indicator based on screenSize.

Parameters


screenSize	Screen size in RemoteDp used to determine stroke width.

Return

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

smallStrokeWidth

Source set: Android

public fun smallStrokeWidth(screenSize: RemoteDp): RemoteDp

Small stroke width for circular progress indicator based on screenSize.

Parameters


screenSize	Screen size in RemoteDp used to determine stroke width.

Return

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

colors

Source set: Android

@Composable
    public fun colors(): RemoteProgressIndicatorColors

Creates a RemoteProgressIndicatorColors with the default colors.

calculateRecommendedGapSize

Source set: Android

public fun calculateRecommendedGapSize(strokeWidth: RemoteDp): RemoteDp

Returns recommended size of the gap based on strokeWidth.

Parameters


strokeWidth	The stroke width of the progress indicator.

colors

Source set: Android

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

Parameters


indicatorColor	The indicator color when enabled, or `null` to use the theme default.
trackColor	The track color when enabled, or `null` to use the theme default.
overflowTrackColor	The overflow track color when enabled, or `null` to use the theme default.
disabledIndicatorColor	The indicator color when disabled, or `null` to use the theme default.
disabledTrackColor	The track color when disabled, or `null` to use the theme default.
disabledOverflowTrackColor	The overflow track color when disabled, or `null` to use the theme default.

colors

Source set: Android

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

Parameters


indicatorBrush	The RemoteBrush used to draw the indicator when enabled.
trackBrush	The RemoteBrush used to draw the track when enabled.
overflowTrackBrush	The RemoteBrush used to draw the overflow track when enabled.
disabledIndicatorBrush	The RemoteBrush used to draw the indicator when disabled.
disabledTrackBrush	The RemoteBrush used to draw the track when disabled.
disabledOverflowTrackBrush	The RemoteBrush used to draw the overflow track when disabled.