RemoteCircularProgressIndicator

Functions summary

Unit	@RemoteComposable @Composable RemoteCircularProgressIndicator(     modifier: RemoteModifier,     colors: RemoteProgressIndicatorColors,     strokeWidth: RemoteDp,     gapSize: RemoteDp ) Indeterminate Material Design circular progress indicator.
Unit	@RemoteComposable @Composable RemoteCircularProgressIndicator(     progress: RemoteFloat,     modifier: RemoteModifier,     enabled: RemoteBoolean,     startAngle: RemoteFloat,     endAngle: RemoteFloat,     colors: RemoteProgressIndicatorColors,     strokeWidth: RemoteDp,     gapSize: RemoteDp ) Material Design circular progress indicator.

Functions

RemoteCircularProgressIndicator

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

View Source

Added in 1.0.0-alpha15

@RemoteComposable
@Composable
fun RemoteCircularProgressIndicator(
    modifier: RemoteModifier = RemoteModifier,
    colors: RemoteProgressIndicatorColors = RemoteProgressIndicatorDefaults.colors(),
    strokeWidth: RemoteDp = RemoteProgressIndicatorDefaults.IndeterminateStrokeWidth,
    gapSize: RemoteDp = RemoteProgressIndicatorDefaults.calculateRecommendedGapSize(strokeWidth)
): Unit

Indeterminate Material Design circular progress indicator.

Indeterminate progress indicator expresses an unspecified wait time and spins indefinitely.

Example of indeterminate circular progress indicator:

import androidx.wear.compose.remote.material3.RemoteCircularProgressIndicator

RemoteCircularProgressIndicator(modifier = modifier)

Parameters
modifier: RemoteModifier = RemoteModifier	Modifier to be applied to the RemoteCircularProgressIndicator.
colors: RemoteProgressIndicatorColors = RemoteProgressIndicatorDefaults.colors()	RemoteProgressIndicatorColors that will be used to resolve the indicator and track color.
strokeWidth: RemoteDp = RemoteProgressIndicatorDefaults.IndeterminateStrokeWidth	The stroke width for the progress indicator.
gapSize: RemoteDp = RemoteProgressIndicatorDefaults.calculateRecommendedGapSize(strokeWidth)	The size (in RemoteDp) of the gap between the ends of the progress indicator and the track.

RemoteCircularProgressIndicator

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

View Source

Added in 1.0.0-alpha15

@RemoteComposable
@Composable
fun RemoteCircularProgressIndicator(
    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)
): Unit

Material Design circular progress indicator.

Animates changes to progress with the RemoteMotionScheme.slowEffectsSpec of RemoteMaterialTheme.motionScheme.

import androidx.compose.remote.creation.compose.state.rf
import androidx.wear.compose.remote.material3.RemoteCircularProgressIndicator

RemoteCircularProgressIndicator(modifier = modifier, progress = 0.75f.rf)

Example that changes progress on click:

import androidx.compose.remote.creation.compose.action.valueChange
import androidx.compose.remote.creation.compose.modifier.clickable
import androidx.compose.remote.creation.compose.state.MutableRemoteFloat
import androidx.compose.remote.creation.compose.state.rf
import androidx.compose.runtime.remember
import androidx.wear.compose.remote.material3.RemoteCircularProgressIndicator

val progress = remember { MutableRemoteFloat { 0.25f.rf } }
val toggleAction = valueChange(progress, ((progress + 0.25f) % 1f).createReference())

// The indicator animates the progress changes.
RemoteCircularProgressIndicator(progress = progress, modifier.clickable(toggleAction))

Parameters
progress: RemoteFloat	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. Progress changes are animated.
modifier: RemoteModifier = RemoteModifier	Modifier to be applied to the RemoteCircularProgressIndicator.
enabled: RemoteBoolean = true.rb	controls the enabled state. When enabled is false, this component will appear visually disabled. Note that only solid colors are supported when enabled is an expression, otherwise it must be a constant.
startAngle: RemoteFloat = RemoteProgressIndicatorDefaults.StartAngle	The starting position of the progress arc, measured clockwise in degrees. For example, 0 is 3 o'clock.
endAngle: RemoteFloat = startAngle	The ending position of the progress arc.
colors: RemoteProgressIndicatorColors = RemoteProgressIndicatorDefaults.colors()	RemoteProgressIndicatorColors that will be used to resolve the indicator and track color.
strokeWidth: RemoteDp = RemoteProgressIndicatorDefaults.DefaultStrokeWidth	The stroke width for the progress indicator. Defaults to RemoteProgressIndicatorDefaults.DefaultStrokeWidth.
gapSize: RemoteDp = RemoteProgressIndicatorDefaults.calculateRecommendedGapSize(strokeWidth)	The size (in RemoteDp) of the gap between the ends of the progress indicator and the track. The stroke endcaps are not included in this distance.