# RemoteCircularProgressIndicator

## Functions summary

|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `@https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/layout/RemoteComposable @https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/wear/compose/remote/material3/RemoteCircularProgressIndicator.composable#RemoteCircularProgressIndicator(androidx.compose.remote.creation.compose.modifier.RemoteModifier,androidx.wear.compose.remote.material3.RemoteProgressIndicatorColors,androidx.compose.remote.creation.compose.state.RemoteDp,androidx.compose.remote.creation.compose.state.RemoteDp)( modifier: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/modifier/RemoteModifier, colors: https://developer.android.com/reference/kotlin/androidx/wear/compose/remote/material3/RemoteProgressIndicatorColors, strokeWidth: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/RemoteDp, gapSize: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/RemoteDp )` Indeterminate Material Design circular progress indicator. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `@https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/layout/RemoteComposable @https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/wear/compose/remote/material3/RemoteCircularProgressIndicator.composable#RemoteCircularProgressIndicator(androidx.compose.remote.creation.compose.state.RemoteFloat,androidx.compose.remote.creation.compose.modifier.RemoteModifier,androidx.compose.remote.creation.compose.state.RemoteBoolean,androidx.compose.remote.creation.compose.state.RemoteFloat,androidx.compose.remote.creation.compose.state.RemoteFloat,androidx.wear.compose.remote.material3.RemoteProgressIndicatorColors,androidx.compose.remote.creation.compose.state.RemoteDp,androidx.compose.remote.creation.compose.state.RemoteDp)( progress: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/RemoteFloat, modifier: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/modifier/RemoteModifier, enabled: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/RemoteBoolean, startAngle: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/RemoteFloat, endAngle: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/RemoteFloat, colors: https://developer.android.com/reference/kotlin/androidx/wear/compose/remote/material3/RemoteProgressIndicatorColors, strokeWidth: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/RemoteDp, gapSize: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/RemoteDp )` Material Design circular progress indicator. |

## Functions

### RemoteCircularProgressIndicator

Artifact: [androidx.wear.compose.remote:remote-material3](https://developer.android.com/jetpack/androidx/releases/wear-compose-remote) [View Source](https://cs.android.com/search?q=file:androidx/wear/compose/remote/material3/RemoteCircularProgressIndicator.kt+function:RemoteCircularProgressIndicator) Added in [1.0.0-alpha15](https://developer.android.com/jetpack/androidx/releases/wear-compose-remote#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:

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

RemoteCircularProgressIndicator(modifier = modifier)
```

| Parameters |
|---|---|
| `modifier: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/modifier/RemoteModifier = RemoteModifier` | Modifier to be applied to the `https://developer.android.com/reference/kotlin/androidx/wear/compose/remote/material3/RemoteCircularProgressIndicator.composable#RemoteCircularProgressIndicator(androidx.compose.remote.creation.compose.modifier.RemoteModifier,androidx.wear.compose.remote.material3.RemoteProgressIndicatorColors,androidx.compose.remote.creation.compose.state.RemoteDp,androidx.compose.remote.creation.compose.state.RemoteDp)`. |
| `colors: https://developer.android.com/reference/kotlin/androidx/wear/compose/remote/material3/RemoteProgressIndicatorColors = RemoteProgressIndicatorDefaults.colors()` | `https://developer.android.com/reference/kotlin/androidx/wear/compose/remote/material3/RemoteProgressIndicatorColors` that will be used to resolve the indicator and track color. |
| `strokeWidth: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/RemoteDp = RemoteProgressIndicatorDefaults.IndeterminateStrokeWidth` | The stroke width for the progress indicator. |
| `gapSize: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/RemoteDp = RemoteProgressIndicatorDefaults.calculateRecommendedGapSize(strokeWidth)` | The size (in `https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/RemoteDp`) of the gap between the ends of the progress indicator and the track. |

### RemoteCircularProgressIndicator

Artifact: [androidx.wear.compose.remote:remote-material3](https://developer.android.com/jetpack/androidx/releases/wear-compose-remote) [View Source](https://cs.android.com/search?q=file:androidx/wear/compose/remote/material3/RemoteCircularProgressIndicator.kt+function:RemoteCircularProgressIndicator) Added in [1.0.0-alpha15](https://developer.android.com/jetpack/androidx/releases/wear-compose-remote#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 `https://developer.android.com/reference/kotlin/androidx/wear/compose/remote/material3/package-summary#RemoteCircularProgressIndicator(androidx.compose.remote.creation.compose.state.RemoteFloat,androidx.compose.remote.creation.compose.modifier.RemoteModifier,androidx.compose.remote.creation.compose.state.RemoteBoolean,androidx.compose.remote.creation.compose.state.RemoteFloat,androidx.compose.remote.creation.compose.state.RemoteFloat,androidx.wear.compose.remote.material3.RemoteProgressIndicatorColors,androidx.compose.remote.creation.compose.state.RemoteDp,androidx.compose.remote.creation.compose.state.RemoteDp)` with the `https://developer.android.com/reference/kotlin/androidx/wear/compose/remote/material3/RemoteMotionScheme#slowEffectsSpec()` of `https://developer.android.com/reference/kotlin/androidx/wear/compose/remote/material3/RemoteMaterialTheme#motionScheme()`.

```kotlin
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 `https://developer.android.com/reference/kotlin/androidx/wear/compose/remote/material3/package-summary#RemoteCircularProgressIndicator(androidx.compose.remote.creation.compose.state.RemoteFloat,androidx.compose.remote.creation.compose.modifier.RemoteModifier,androidx.compose.remote.creation.compose.state.RemoteBoolean,androidx.compose.remote.creation.compose.state.RemoteFloat,androidx.compose.remote.creation.compose.state.RemoteFloat,androidx.wear.compose.remote.material3.RemoteProgressIndicatorColors,androidx.compose.remote.creation.compose.state.RemoteDp,androidx.compose.remote.creation.compose.state.RemoteDp)` on click:

```kotlin
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: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/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: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/modifier/RemoteModifier = RemoteModifier` | Modifier to be applied to the `https://developer.android.com/reference/kotlin/androidx/wear/compose/remote/material3/RemoteCircularProgressIndicator.composable#RemoteCircularProgressIndicator(androidx.compose.remote.creation.compose.state.RemoteFloat,androidx.compose.remote.creation.compose.modifier.RemoteModifier,androidx.compose.remote.creation.compose.state.RemoteBoolean,androidx.compose.remote.creation.compose.state.RemoteFloat,androidx.compose.remote.creation.compose.state.RemoteFloat,androidx.wear.compose.remote.material3.RemoteProgressIndicatorColors,androidx.compose.remote.creation.compose.state.RemoteDp,androidx.compose.remote.creation.compose.state.RemoteDp)`. |
| `enabled: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/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 `https://developer.android.com/reference/kotlin/androidx/wear/compose/remote/material3/package-summary#RemoteCircularProgressIndicator(androidx.compose.remote.creation.compose.state.RemoteFloat,androidx.compose.remote.creation.compose.modifier.RemoteModifier,androidx.compose.remote.creation.compose.state.RemoteBoolean,androidx.compose.remote.creation.compose.state.RemoteFloat,androidx.compose.remote.creation.compose.state.RemoteFloat,androidx.wear.compose.remote.material3.RemoteProgressIndicatorColors,androidx.compose.remote.creation.compose.state.RemoteDp,androidx.compose.remote.creation.compose.state.RemoteDp)` is an expression, otherwise it must be a constant. |
| `startAngle: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/RemoteFloat = RemoteProgressIndicatorDefaults.StartAngle` | The starting position of the progress arc, measured clockwise in degrees. For example, 0 is 3 o'clock. |
| `endAngle: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/RemoteFloat = startAngle` | The ending position of the progress arc. |
| `colors: https://developer.android.com/reference/kotlin/androidx/wear/compose/remote/material3/RemoteProgressIndicatorColors = RemoteProgressIndicatorDefaults.colors()` | `https://developer.android.com/reference/kotlin/androidx/wear/compose/remote/material3/RemoteProgressIndicatorColors` that will be used to resolve the indicator and track color. |
| `strokeWidth: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/RemoteDp = RemoteProgressIndicatorDefaults.DefaultStrokeWidth` | The stroke width for the progress indicator. Defaults to `https://developer.android.com/reference/kotlin/androidx/wear/compose/remote/material3/RemoteProgressIndicatorDefaults#DefaultStrokeWidth()`. |
| `gapSize: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/RemoteDp = RemoteProgressIndicatorDefaults.calculateRecommendedGapSize(strokeWidth)` | The size (in `https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/RemoteDp`) of the gap between the ends of the progress indicator and the track. The stroke endcaps are not included in this distance. |