basic-images/app.lexilabs.basic.images

Package-level declarations

Types

Used to convert the String of an absolute file path to an BasicPath object. This was a critical feature to prevent URL Strings from being confused with Path Strings.

BasicUrl

class BasicUrl(urlString: String)

Used to convert the String of an absolute file path to an BasicUrl object. This was a critical feature to prevent URL Strings from being confused with Path Strings.

ExperimentalBasicImages

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY])

annotation class ExperimentalBasicImages

This API is not considered 'production' until reaching version 1.0.0 or higher

ImageClient

object ImageClient

Gets and caches an image file by urlString after invoke of ImageClient instance.

ImageLoader

actual object ImageLoader

Contains load functions for BasicImage that accepts both BasicUrl and BasicPath objects.

expect object ImageLoader

Contains load functions for BasicImage that accepts both BasicUrl and BasicPath objects.

actual object ImageLoader

Contains load functions for BasicImage that accepts both BasicUrl and BasicPath objects.

actual object ImageLoader

Contains load functions for BasicImage that accepts both BasicUrl and BasicPath objects.

actual object ImageLoader

Contains load functions for BasicImage that accepts both BasicUrl and BasicPath objects.

ImageState

sealed class ImageState

Indicates the current state of an BasicImage as it proceeds through the ImageLoader.load cycle

Functions

BasicImage

@Composable

fun BasicImage(path: BasicPath, contentDescription: String? = null, modifier: Modifier = Modifier, alignment: Alignment = Alignment.Center, contentScale: ContentScale = ContentScale.Fit, alpha: Float = DefaultAlpha, colorFilter: ColorFilter? = null, filterQuality: FilterQuality = DefaultFilterQuality, placeholderEnabled: Boolean = true)

A composable that lays out and asynchronously draws a ImageBitmap from a given BasicPath using a LaunchedEffect.

@Composable

fun BasicImage(url: BasicUrl, contentDescription: String? = null, modifier: Modifier = Modifier, alignment: Alignment = Alignment.Center, contentScale: ContentScale = ContentScale.Fit, alpha: Float = DefaultAlpha, colorFilter: ColorFilter? = null, filterQuality: FilterQuality = DefaultFilterQuality, placeholderEnabled: Boolean = true)

A composable that lays out and asynchronously draws a ImageBitmap from a given BasicUrl using a LaunchedEffect.

BasicImagePlaceHolder

@Composable

fun BasicImagePlaceHolder(modifier: Modifier = Modifier)

A composable that displays while waiting on a BasicImage to load.