shimmer/com.valentinilk.shimmer

Package-level declarations

Types

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

Properties

defaultShimmerTheme

val defaultShimmerTheme: ShimmerTheme

LocalShimmerTheme

val LocalShimmerTheme: ProvidableCompositionLocal<ShimmerTheme>

Functions

rememberShimmer

@Composable

fun rememberShimmer(shimmerBounds: ShimmerBounds, theme: ShimmerTheme = LocalShimmerTheme.current): Shimmer

shimmer

@Composable

fun Modifier.shimmer(customShimmer: Shimmer = rememberShimmer(ShimmerBounds.View)): Modifier

shimmerSpec

@Stable

fun shimmerSpec(durationMillis: Int = DefaultDurationMillis, delayMillis: Int = 0, easing: Easing = LinearEasing): KeyframesSpec<Float>

Creates a KeyframesSpec which animates from 0f to 1f during the time span defined in durationMillis. The additional delayMillis define how long the animation will stay at its final value of 1f before the animation ends. The spec will ignore any initial or target value defined in an Animatable.

unclippedBoundsInWindow

fun LayoutCoordinates.unclippedBoundsInWindow(): Rect

The regular boundsInWindow returns a rect that is clipped by the edges of the window. So if a view is scrolled half way out of the screen, the rect returned would only have half the size required for the shimmer calculations.