coil-compose-core/coil3.compose/SubcomposeAsyncImage

SubcomposeAsyncImage

@Composable
fun SubcomposeAsyncImage(model: Any?, contentDescription: String?, imageLoader: ImageLoader, modifier: Modifier = Modifier, transform: (AsyncImagePainter.State) -> AsyncImagePainter.State = DefaultTransform, loading: @Composable SubcomposeAsyncImageScope.(AsyncImagePainter.State.Loading) -> Unit? = null, success: @Composable SubcomposeAsyncImageScope.(AsyncImagePainter.State.Success) -> Unit? = null, error: @Composable SubcomposeAsyncImageScope.(AsyncImagePainter.State.Error) -> Unit? = null, onLoading: (AsyncImagePainter.State.Loading) -> Unit? = null, onSuccess: (AsyncImagePainter.State.Success) -> Unit? = null, onError: (AsyncImagePainter.State.Error) -> Unit? = null, alignment: Alignment = Alignment.Center, contentScale: ContentScale = ContentScale.Fit, alpha: Float = DefaultAlpha, colorFilter: ColorFilter? = null, filterQuality: FilterQuality = DefaultFilterQuality, clipToBounds: Boolean = true)

A composable that executes an ImageRequest asynchronously and renders the result.

NOTE: This API uses subcomposition, which is slow. Avoid using this composable in places that need high performance (e.g. LazyRow/LazyColumn).

Parameters

model

Either an ImageRequest or the ImageRequest.data value.

contentDescription

Text used by accessibility services to describe what this image represents. This should always be provided unless this image is used for decorative purposes, and does not represent a meaningful action that a user can take.

imageLoader

The ImageLoader that will be used to execute the request.

modifier

Modifier used to adjust the layout algorithm or draw decoration content.

loading

An optional callback to overwrite what's drawn while the image request is loading.

success

An optional callback to overwrite what's drawn when the image request succeeds.

error

An optional callback to overwrite what's drawn when the image request fails.

onLoading

Called when the image request begins loading.

onSuccess

Called when the image request completes successfully.

onError

Called when the image request completes unsuccessfully.

alignment

Optional alignment parameter used to place the AsyncImagePainter in the given bounds defined by the width and height.

contentScale

Optional scale parameter used to determine the aspect ratio scaling to be used if the bounds are a different size from the intrinsic size of the AsyncImagePainter.

alpha

Optional opacity to be applied to the AsyncImagePainter when it is rendered onscreen.

colorFilter

Optional ColorFilter to apply for the AsyncImagePainter when it is rendered onscreen.

filterQuality

Sampling algorithm applied to a bitmap when it is scaled and drawn into the destination.

clipToBounds

If true, clips the content to its bounds. Else, it will not be clipped.

@Composable
fun SubcomposeAsyncImage(model: Any?, contentDescription: String?, imageLoader: ImageLoader, modifier: Modifier = Modifier, transform: (AsyncImagePainter.State) -> AsyncImagePainter.State = DefaultTransform, onState: (AsyncImagePainter.State) -> Unit? = null, alignment: Alignment = Alignment.Center, contentScale: ContentScale = ContentScale.Fit, alpha: Float = DefaultAlpha, colorFilter: ColorFilter? = null, filterQuality: FilterQuality = DefaultFilterQuality, clipToBounds: Boolean = true, content: @Composable SubcomposeAsyncImageScope.() -> Unit)

A composable that executes an ImageRequest asynchronously and renders the result.

NOTE: This API uses subcomposition, which is slow. Avoid using this composable in places that need high performance (e.g. LazyRow/LazyColumn).

Parameters

model

Either an ImageRequest or the ImageRequest.data value.

contentDescription

Text used by accessibility services to describe what this image represents. This should always be provided unless this image is used for decorative purposes, and does not represent a meaningful action that a user can take.

imageLoader

The ImageLoader that will be used to execute the request.

modifier

Modifier used to adjust the layout algorithm or draw decoration content.

transform

A callback to transform a new State before it's applied to the AsyncImagePainter. Typically this is used to modify the state's Painter.

onState

Called when the state of this painter changes.

alignment

Optional alignment parameter used to place the AsyncImagePainter in the given bounds defined by the width and height.

contentScale

Optional scale parameter used to determine the aspect ratio scaling to be used if the bounds are a different size from the intrinsic size of the AsyncImagePainter.

alpha

Optional opacity to be applied to the AsyncImagePainter when it is rendered onscreen.

colorFilter

Optional ColorFilter to apply for the AsyncImagePainter when it is rendered onscreen.

filterQuality

Sampling algorithm applied to a bitmap when it is scaled and drawn into the destination.

clipToBounds

If true, clips the content to its bounds. Else, it will not be clipped.

content

A callback to draw the content inside a SubcomposeAsyncImageScope.