CircularProgressIndicatorDefaults

Artifact: androidx.wear.protolayout:protolayout-material3

View Source

Added in 1.3.0-alpha06

---

Kotlin |Java

object CircularProgressIndicatorDefaults

---

Summary

Constants
const @Dimension(unit = 0) Float	LARGE_STROKE_WIDTH = 8.0f Large stroke width for circular progress indicator.
const @Dimension(unit = 0) Float	SMALL_STROKE_WIDTH = 4.0f Small stroke width for circular progress indicator.

Public functions
@Dimension(unit = 0) Float	calculateRecommendedGapSize(strokeWidth: @Dimension(unit = 0) Float) Returns recommended size of the gap based on strokeWidth.
ProgressIndicatorColors	MaterialScope.filledProgressIndicatorColors() Returns the recommended ProgressIndicatorColors object to be used when placing the progress indicator inside a graphic card with CardDefaults.filledCardColors.
ProgressIndicatorColors	MaterialScope.filledTonalProgressIndicatorColors() Returns the recommended ProgressIndicatorColors object to be used when placing the progress indicator inside a graphic card with CardDefaults.filledTonalCardColors.
ProgressIndicatorColors	MaterialScope.filledVariantProgressIndicatorColors() Returns the recommended ProgressIndicatorColors object to be used when placing the progress indicator inside a graphic card with CardDefaults.filledVariantCardColors.

Public properties
AnimationParameterBuilders.AnimationSpec	recommendedAnimationSpec The recommended animation spec for animations from current progress to a new progress value.

Constants

LARGE_STROKE_WIDTH

Added in 1.3.0-alpha06

const val LARGE_STROKE_WIDTH = 8.0f: @Dimension(unit = 0) Float

Large stroke width for circular progress indicator.

SMALL_STROKE_WIDTH

Added in 1.3.0-alpha06

const val SMALL_STROKE_WIDTH = 4.0f: @Dimension(unit = 0) Float

Small stroke width for circular progress indicator.

Public functions

calculateRecommendedGapSize

Added in 1.3.0-alpha06

fun calculateRecommendedGapSize(strokeWidth: @Dimension(unit = 0) Float): @Dimension(unit = 0) Float

Returns recommended size of the gap based on strokeWidth.

The absolute value can be customized with gapSize parameter on circularProgressIndicator.

filledProgressIndicatorColors

Artifact: androidx.wear.protolayout:protolayout-material3

View Source

Added in 1.3.0-alpha06

fun MaterialScope.filledProgressIndicatorColors(): ProgressIndicatorColors

Returns the recommended ProgressIndicatorColors object to be used when placing the progress indicator inside a graphic card with CardDefaults.filledCardColors.

filledTonalProgressIndicatorColors

Artifact: androidx.wear.protolayout:protolayout-material3

View Source

Added in 1.3.0-alpha06

fun MaterialScope.filledTonalProgressIndicatorColors(): ProgressIndicatorColors

Returns the recommended ProgressIndicatorColors object to be used when placing the progress indicator inside a graphic card with CardDefaults.filledTonalCardColors.

filledVariantProgressIndicatorColors

Artifact: androidx.wear.protolayout:protolayout-material3

View Source

Added in 1.3.0-alpha06

fun MaterialScope.filledVariantProgressIndicatorColors(): ProgressIndicatorColors

Returns the recommended ProgressIndicatorColors object to be used when placing the progress indicator inside a graphic card with CardDefaults.filledVariantCardColors.

Public properties

recommendedAnimationSpec

Added in 1.3.0-alpha06

val recommendedAnimationSpec: AnimationParameterBuilders.AnimationSpec

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