shimmer/com.valentinilk.shimmer/ShimmerTheme

ShimmerTheme

data class ShimmerTheme(val animationSpec: AnimationSpec<Float>, val blendMode: BlendMode, val rotation: Float, val shaderColors: List<Color>, val shaderColorStops: List<Float>?, val shimmerWidth: Dp)

Constructors

ShimmerTheme

constructor(animationSpec: AnimationSpec<Float>, blendMode: BlendMode, rotation: Float, shaderColors: List<Color>, shaderColorStops: List<Float>?, shimmerWidth: Dp)

Properties

animationSpec

val animationSpec: AnimationSpec<Float>

The AnimationSpec which will be used for the traversal. Use an infinite spec to repeat shimmering.

blendMode

val blendMode: BlendMode

The BlendMode used in the shimmer's androidx.compose.ui.graphics.Paint. Have a look at the theming samples to get an idea on how to utilize the blend mode.

rotation

val rotation: Float

Describes the orientation of the shimmer in degrees. Zero is thereby defined as shimmer traversing from the left to the right. The rotation is applied clockwise. Only values >= 0 will be accepted.

shaderColors

val shaderColors: List<Color>

The shaderColors can be used to control the colors and alpha values of the shimmer. The size of the list has to be kept in sync with the shaderColorStops. Consult the docs of the androidx.compose.ui.graphics.LinearGradientShader for more information and have a look at the theming samples.

shaderColorStops

val shaderColorStops: List<Float>?

See docs of shaderColors.

shimmerWidth

val shimmerWidth: Dp

Controls the width used to distribute the shaderColors.