basic-images/app.lexilabs.basic.images

Package-level declarations

Types

BasicPath

class BasicPath(pathString: String)

Represents a local file path for an image.

BasicUrl

class BasicUrl(urlString: String)

Represents a URL for an image.

ExperimentalBasicImages

@RequiresOptIn(message = "This API is experimental, unstable, and may change.")

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

annotation class ExperimentalBasicImages

Marks declarations that are part of the experimental Basic Images API.

ImageClient

object ImageClient

A Ktor HTTP client for downloading images from a URL.

ImageLoader

actual object ImageLoader

Android-specific implementation for loading images from a BasicUrl or BasicPath. This object provides functions to load images and convert them into an ImageBitmap.

expect object ImageLoader

An expect object for loading images from a BasicUrl or BasicPath.

actual object ImageLoader

iOS-specific implementation for loading images from a BasicUrl or BasicPath. This object provides functions to load images and convert them into an ImageBitmap.

actual object ImageLoader

An expect object for loading images from a BasicUrl or BasicPath.

actual object ImageLoader

JVM-specific implementation for loading images from a BasicUrl or BasicPath. This object provides functions to load images and convert them into an ImageBitmap.

actual object ImageLoader

macOS-specific implementation for loading images from a BasicUrl or BasicPath. This object provides functions to load images and convert them into an ImageBitmap.

actual object ImageLoader

An expect object for loading images from a BasicUrl or BasicPath.

ImageState

sealed class ImageState

Represents the different states of image loading for a BasicImage.

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 asynchronously loads and displays an image from a local BasicPath.

@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 asynchronously loads and displays an image from a BasicUrl.

BasicImagePlaceHolder

@Composable

fun BasicImagePlaceHolder(modifier: Modifier = Modifier)

A composable that displays a CircularProgressIndicator as a placeholder.