CircularProgressIndicatorDefaults

Artifact: androidx.wear.protolayout:protolayout-material3

View Source

Added in 1.3.0-alpha06

---

Kotlin |Java

public static class CircularProgressIndicatorDefaults

---

Summary

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

Public fields
static @NonNull CircularProgressIndicatorDefaults	INSTANCE

Public methods
final @Dimension(unit = 0) float	calculateRecommendedGapSize(@Dimension(unit = 0) float strokeWidth) Returns recommended size of the gap based on strokeWidth.
final @NonNull ProgressIndicatorColors	filledProgressIndicatorColors(@NonNull MaterialScope receiver) Returns the recommended ProgressIndicatorColors object to be used when placing the progress indicator inside a graphic card with CardDefaults.filledCardColors.
final @NonNull ProgressIndicatorColors	filledTonalProgressIndicatorColors(@NonNull MaterialScope receiver) Returns the recommended ProgressIndicatorColors object to be used when placing the progress indicator inside a graphic card with CardDefaults.filledTonalCardColors.
final @NonNull ProgressIndicatorColors	filledVariantProgressIndicatorColors(@NonNull MaterialScope receiver) Returns the recommended ProgressIndicatorColors object to be used when placing the progress indicator inside a graphic card with CardDefaults.filledVariantCardColors.
final @NonNull AnimationParameterBuilders.AnimationSpec	getRecommendedAnimationSpec() The recommended animation spec for animations from current progress to a new progress value.

Constants

LARGE_STROKE_WIDTH

Added in 1.3.0-alpha06

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-alpha06

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-alpha06

public static @NonNull CircularProgressIndicatorDefaults INSTANCE

Public methods

calculateRecommendedGapSize

Added in 1.3.0-alpha06

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

Returns recommended size of the gap based on strokeWidth.

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

filledProgressIndicatorColors

Added in 1.3.0-alpha06

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

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

filledTonalProgressIndicatorColors

Added in 1.3.0-alpha06

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

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

filledVariantProgressIndicatorColors

Added in 1.3.0-alpha06

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

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

getRecommendedAnimationSpec

Added in 1.3.0-alpha06

public final @NonNull AnimationParameterBuilders.AnimationSpec getRecommendedAnimationSpec()

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