spark/com.adevinta.spark.components.placeholder/shimmer

shimmer

fun PlaceholderHighlight.Companion.shimmer(highlightColor: Color, animationSpec: InfiniteRepeatableSpec<Float> = PlaceholderDefaults.shimmerAnimationSpec, @FloatRange(from = 0.0, to = 1.0) progressForMaxAlpha: Float = 0.6f): PlaceholderHighlight

Creates a PlaceholderHighlight which 'shimmers', using the given highlightColor.

The highlight starts at the top-start, and then grows to the bottom-end during the animation. During that time it is also faded in, from 0f..progressForMaxAlpha, and then faded out from progressForMaxAlpha..1f.

Parameters

highlightColor

the color of the highlight 'shimmer'.

animationSpec

the AnimationSpec to configure the animation.

progressForMaxAlpha

The progress where the shimmer should be at it's peak opacity. Defaults to 0.6f.

@Composable
fun PlaceholderHighlight.Companion.shimmer(animationSpec: InfiniteRepeatableSpec<Float> = PlaceholderDefaults.shimmerAnimationSpec, @FloatRange(from = 0.0, to = 1.0) progressForMaxAlpha: Float = 0.6f): PlaceholderHighlight

Creates a PlaceholderHighlight which 'shimmers', using a default color.

The highlight starts at the top-start, and then grows to the bottom-end during the animation. During that time it is also faded in, from 0f..progressForMaxAlpha, and then faded out from progressForMaxAlpha..1f.

Parameters

animationSpec

the AnimationSpec to configure the animation.

progressForMaxAlpha

The progress where the shimmer should be at it's peak opacity. Defaults to 0.6f.