# CircularProgressIndicatorDefaults

Artifact: [androidx.wear.protolayout:protolayout-material3](https://developer.android.com/jetpack/androidx/releases/wear-protolayout) [View Source](https://cs.android.com/search?q=file:androidx/wear/protolayout/material3/CircularProgressIndicatorDefaults.kt+class:androidx.wear.protolayout.material3.CircularProgressIndicatorDefaults) Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.3.0)

*** ** * ** ***


```
public static class CircularProgressIndicatorDefaults
```

<br />

*** ** * ** ***

## Summary

| ### Constants |
|---|---|
| `static final @https://developer.android.com/reference/androidx/annotation/Dimension(unit = 0) float` | `https://developer.android.com/reference/androidx/wear/protolayout/material3/CircularProgressIndicatorDefaults#LARGE_STROKE_WIDTH() = 8.0f` Large stroke width for circular progress indicator. |
| `static final @https://developer.android.com/reference/androidx/annotation/Dimension(unit = 0) float` | `https://developer.android.com/reference/androidx/wear/protolayout/material3/CircularProgressIndicatorDefaults#SMALL_STROKE_WIDTH() = 4.0f` Small stroke width for circular progress indicator. |

| ### Public fields |
|---|---|
| `static @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/protolayout/material3/CircularProgressIndicatorDefaults` | `https://developer.android.com/reference/androidx/wear/protolayout/material3/CircularProgressIndicatorDefaults#INSTANCE()` |

| ### Public methods |
|---|---|
| `final @https://developer.android.com/reference/androidx/annotation/Dimension(unit = 0) float` | `https://developer.android.com/reference/androidx/wear/protolayout/material3/CircularProgressIndicatorDefaults#calculateRecommendedGapSize(kotlin.Float)(@https://developer.android.com/reference/androidx/annotation/Dimension(unit = 0) float strokeWidth)` Returns recommended size of the gap based on `https://developer.android.com/reference/androidx/wear/protolayout/material3/CircularProgressIndicatorDefaults#calculateRecommendedGapSize(kotlin.Float)`. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/protolayout/material3/ProgressIndicatorColors` | `https://developer.android.com/reference/androidx/wear/protolayout/material3/CircularProgressIndicatorDefaults#(androidx.wear.protolayout.material3.MaterialScope).filledProgressIndicatorColors()(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/protolayout/material3/MaterialScope receiver)` Returns the recommended `https://developer.android.com/reference/androidx/wear/protolayout/material3/ProgressIndicatorColors` object to be used when placing the progress indicator inside a graphic card with `https://developer.android.com/reference/androidx/wear/protolayout/material3/CardDefaults#(androidx.wear.protolayout.material3.MaterialScope).filledCardColors()` from the given `https://developer.android.com/reference/androidx/wear/protolayout/material3/MaterialScope`'s `https://developer.android.com/reference/androidx/wear/protolayout/material3/ColorScheme`. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/protolayout/material3/ProgressIndicatorColors` | `https://developer.android.com/reference/androidx/wear/protolayout/material3/CircularProgressIndicatorDefaults#(androidx.wear.protolayout.material3.MaterialScope).filledTonalProgressIndicatorColors()(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/protolayout/material3/MaterialScope receiver)` Returns the recommended `https://developer.android.com/reference/androidx/wear/protolayout/material3/ProgressIndicatorColors` object to be used when placing the progress indicator inside a graphic card with `https://developer.android.com/reference/androidx/wear/protolayout/material3/CardDefaults#(androidx.wear.protolayout.material3.MaterialScope).filledTonalCardColors()` from the given `https://developer.android.com/reference/androidx/wear/protolayout/material3/MaterialScope`'s `https://developer.android.com/reference/androidx/wear/protolayout/material3/ColorScheme`. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/protolayout/material3/ProgressIndicatorColors` | `https://developer.android.com/reference/androidx/wear/protolayout/material3/CircularProgressIndicatorDefaults#(androidx.wear.protolayout.material3.MaterialScope).filledVariantProgressIndicatorColors()(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/protolayout/material3/MaterialScope receiver)` Returns the recommended `https://developer.android.com/reference/androidx/wear/protolayout/material3/ProgressIndicatorColors` object to be used when placing the progress indicator inside a graphic card with `https://developer.android.com/reference/androidx/wear/protolayout/material3/CardDefaults#(androidx.wear.protolayout.material3.MaterialScope).filledVariantCardColors()` from the given `https://developer.android.com/reference/androidx/wear/protolayout/material3/MaterialScope`'s `https://developer.android.com/reference/androidx/wear/protolayout/material3/ColorScheme`. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/protolayout/expression/AnimationParameterBuilders.AnimationSpec` | `https://developer.android.com/reference/androidx/wear/protolayout/material3/CircularProgressIndicatorDefaults#getRecommendedAnimationSpec()()` The recommended animation spec for animations from current progress to a new progress value. |

## Constants

### LARGE_STROKE_WIDTH

Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.3.0)

```
public static final @Dimension(unit = 0) float LARGE_STROKE_WIDTH = 8.0f
```

Large stroke width for circular progress indicator.

### SMALL_STROKE_WIDTH

Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.3.0)

```
public static final @Dimension(unit = 0) float SMALL_STROKE_WIDTH = 4.0f
```

Small stroke width for circular progress indicator.

## Public fields

### INSTANCE

Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.3.0)

```
public static @NonNull CircularProgressIndicatorDefaults INSTANCE
```

## Public methods

### calculateRecommendedGapSize

Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.3.0)

```
public final @Dimension(unit = 0) float calculateRecommendedGapSize(@Dimension(unit = 0) float strokeWidth)
```

Returns recommended size of the gap based on `https://developer.android.com/reference/androidx/wear/protolayout/material3/CircularProgressIndicatorDefaults#calculateRecommendedGapSize(kotlin.Float)`.

The absolute value can be customized with `gapSize` parameter on `https://developer.android.com/reference/androidx/wear/protolayout/material3/package-summary#(androidx.wear.protolayout.material3.MaterialScope).circularProgressIndicator(kotlin.Float,androidx.wear.protolayout.expression.DynamicBuilders.DynamicFloat,androidx.wear.protolayout.modifiers.LayoutModifier,kotlin.Float,kotlin.Float,kotlin.Float,kotlin.Float,androidx.wear.protolayout.material3.ProgressIndicatorColors,androidx.wear.protolayout.DimensionBuilders.ContainerDimension)`.

### filledProgressIndicatorColors

Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.3.0)

```
public final @NonNull ProgressIndicatorColors filledProgressIndicatorColors(@NonNull MaterialScope receiver)
```

Returns the recommended `https://developer.android.com/reference/androidx/wear/protolayout/material3/ProgressIndicatorColors` object to be used when placing the progress indicator inside a graphic card with `https://developer.android.com/reference/androidx/wear/protolayout/material3/CardDefaults#(androidx.wear.protolayout.material3.MaterialScope).filledCardColors()` from the given `https://developer.android.com/reference/androidx/wear/protolayout/material3/MaterialScope`'s `https://developer.android.com/reference/androidx/wear/protolayout/material3/ColorScheme`.

### filledTonalProgressIndicatorColors

Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.3.0)

```
public final @NonNull ProgressIndicatorColors filledTonalProgressIndicatorColors(@NonNull MaterialScope receiver)
```

Returns the recommended `https://developer.android.com/reference/androidx/wear/protolayout/material3/ProgressIndicatorColors` object to be used when placing the progress indicator inside a graphic card with `https://developer.android.com/reference/androidx/wear/protolayout/material3/CardDefaults#(androidx.wear.protolayout.material3.MaterialScope).filledTonalCardColors()` from the given `https://developer.android.com/reference/androidx/wear/protolayout/material3/MaterialScope`'s `https://developer.android.com/reference/androidx/wear/protolayout/material3/ColorScheme`.

### filledVariantProgressIndicatorColors

Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.3.0)

```
public final @NonNull ProgressIndicatorColors filledVariantProgressIndicatorColors(@NonNull MaterialScope receiver)
```

Returns the recommended `https://developer.android.com/reference/androidx/wear/protolayout/material3/ProgressIndicatorColors` object to be used when placing the progress indicator inside a graphic card with `https://developer.android.com/reference/androidx/wear/protolayout/material3/CardDefaults#(androidx.wear.protolayout.material3.MaterialScope).filledVariantCardColors()` from the given `https://developer.android.com/reference/androidx/wear/protolayout/material3/MaterialScope`'s `https://developer.android.com/reference/androidx/wear/protolayout/material3/ColorScheme`.

### getRecommendedAnimationSpec

Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.3.0)

```
public final @NonNull AnimationParameterBuilders.AnimationSpec getRecommendedAnimationSpec()
```

The recommended animation spec for animations from current progress to a new progress value.