Package com.skydoves.landscapist

Types

ImageLoadState
Link copied to clipboard
sealed class ImageLoadState
FrescoImageState is a common interface of the image requesting states.
ShimmerParams
Link copied to clipboard
data class ShimmerParams(baseColor: Color, highlightColor: Color, intensity: Float, dropOff: Float, tilt: Float, durationMillis: Int)
Shimmer params holds attributes of the Shimmer composable.

Functions

CircularRevealedImage
Link copied to clipboard
@Composable()
fun CircularRevealedImage(bitmap: ImageBitmap, modifier: Modifier = Modifier, bitmapPainter: Painter = BitmapPainter(bitmap), alignment: Alignment = Alignment.Center, contentScale: ContentScale = ContentScale.Crop, contentDescription: String?, alpha: Float = DefaultAlpha, colorFilter: ColorFilter? = null, circularRevealedEnabled: Boolean = false, circularRevealedDuration: Int = DefaultCircularRevealedDuration)
CircularRevealedImage is an image composable for animating a clipping circle to reveal when loading an image.
ImageBySource
Link copied to clipboard
@Composable()
fun ImageBySource(source: Any, modifier: Modifier, alignment: Alignment, contentScale: ContentScale = ContentScale.Crop, contentDescription: String? = null, colorFilter: ColorFilter? = null, alpha: Float = DefaultAlpha)
Draw image using a drawable source one of ImageBitmap, ImageVector, or Painter.
ImageLoad
Link copied to clipboard
@Composable()
fun <T : Any> ImageLoad(recomposeKey: T?, executeImageRequest: suspend () -> Flow<ImageLoadState>, modifier: Modifier = Modifier, content: @Composable() (imageState: ImageLoadState) -> Unit)
A common image loading model for fetching an image asynchronously and run composable for displaying the image.
Shimmer
Link copied to clipboard
@Composable()
fun Shimmer(modifier: Modifier = Modifier, baseColor: Color, highlightColor: Color, intensity: Float = DefaultShimmerIntensity, dropOff: Float = DefaultShimmerDropOff, tilt: Float = DefaultShimmerTilt, durationMillis: Int = DefaultDurationMillis)
Create a shimmering effect composable with base and highlighting colors.

Properties

DefaultCircularRevealedDuration
Link copied to clipboard
const val DefaultCircularRevealedDuration: Int = 350
a definition of the default circular revealed animations duration.
LocalShimmerParams
Link copied to clipboard
val LocalShimmerParams: ProvidableCompositionLocal<ShimmerParams>
Local containing the preferred ShimmerParams for providing the same instance in the composable hierarchy.