RemoteProgressIndicatorDefaults

object RemoteProgressIndicatorDefaults

Contains defaults for Remote Progress Indicators.

Summary

Public functions
RemoteDp

Returns recommended size of the gap based on strokeWidth.
RemoteProgressIndicatorColors

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

Large stroke width for circular progress indicator based on screenSize.
RemoteDp

Small stroke width for circular progress indicator based on screenSize.

Public properties
RemoteFloat

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

Default gap angle in degrees for RemoteCurvedProgressIndicator.
RemoteDp

Default padding from edge for RemoteCurvedProgressIndicator.
RemoteFloat

Default start angle for RemoteCurvedProgressIndicator.
RemoteDp

Default stroke width for RemoteCurvedProgressIndicator.
RemoteFloat

Default sweep angle for RemoteCurvedProgressIndicator.
RemoteDp

Default stroke width for RemoteCircularProgressIndicator.
RemoteDp

Default stroke width for indeterminate RemoteCircularProgressIndicator.
RemoteFloat

Default start angle for RemoteCircularProgressIndicator.

Public functions

calculateRecommendedGapSize

Added in 1.0.0-alpha15
fun calculateRecommendedGapSize(strokeWidth: RemoteDp): RemoteDp

Returns recommended size of the gap based on strokeWidth.

Parameters
strokeWidth: RemoteDp

The stroke width of the progress indicator.

colors

Added in 1.0.0-alpha15
@Composable
@RemoteComposable
fun colors(): RemoteProgressIndicatorColors

Creates a RemoteProgressIndicatorColors with the default colors.

colors

Added in 1.0.0-alpha15
@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.

Parameters
indicatorBrush: RemoteBrush? = null

The RemoteBrush used to draw the indicator when enabled.
trackBrush: RemoteBrush? = null

The RemoteBrush used to draw the track when enabled.
overflowTrackBrush: RemoteBrush? = null

The RemoteBrush used to draw the overflow track when enabled.
disabledIndicatorBrush: RemoteBrush? = null

The RemoteBrush used to draw the indicator when disabled.
disabledTrackBrush: RemoteBrush? = null

The RemoteBrush used to draw the track when disabled.
disabledOverflowTrackBrush: RemoteBrush? = null

The RemoteBrush used to draw the overflow track when disabled.

colors

Added in 1.0.0-alpha15
@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.

Parameters
indicatorColor: RemoteColor? = null

The indicator color when enabled, or null to use the theme default.
trackColor: RemoteColor? = null

The track color when enabled, or null to use the theme default.
overflowTrackColor: RemoteColor? = null

The overflow track color when enabled, or null to use the theme default.
disabledIndicatorColor: RemoteColor? = null

The indicator color when disabled, or null to use the theme default.
disabledTrackColor: RemoteColor? = null

The track color when disabled, or null to use the theme default.
disabledOverflowTrackColor: RemoteColor? = null

The overflow track color when disabled, or null to use the theme default.

largeStrokeWidth

Added in 1.0.0-alpha15
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-alpha15
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-alpha15
val CurvedIndicatorDotFadeOutFraction: RemoteFloat

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

CurvedIndicatorGapAngleDegrees

Added in 1.0.0-alpha15
val CurvedIndicatorGapAngleDegrees: RemoteFloat

Default gap angle in degrees for RemoteCurvedProgressIndicator.

CurvedIndicatorPadding

Added in 1.0.0-alpha15
val CurvedIndicatorPadding: RemoteDp

Default padding from edge for RemoteCurvedProgressIndicator.

CurvedIndicatorStartAngle

Added in 1.0.0-alpha15
val CurvedIndicatorStartAngle: RemoteFloat

Default start angle for RemoteCurvedProgressIndicator.

CurvedIndicatorStrokeWidth

Added in 1.0.0-alpha15
val CurvedIndicatorStrokeWidth: RemoteDp

Default stroke width for RemoteCurvedProgressIndicator.

CurvedIndicatorSweepAngle

Added in 1.0.0-alpha15
val CurvedIndicatorSweepAngle: RemoteFloat

Default sweep angle for RemoteCurvedProgressIndicator.

DefaultStrokeWidth

Added in 1.0.0-alpha15
val DefaultStrokeWidth: RemoteDp

Default stroke width for RemoteCircularProgressIndicator.

IndeterminateStrokeWidth

Added in 1.0.0-alpha15
val IndeterminateStrokeWidth: RemoteDp

Default stroke width for indeterminate RemoteCircularProgressIndicator.

StartAngle

Added in 1.0.0-alpha15
val StartAngle: RemoteFloat

Default start angle for RemoteCircularProgressIndicator.