Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove unclear warning in AsyncImagePainter docs. #2711

Merged
merged 1 commit into from
Nov 22, 2024
Merged

Remove unclear warning in AsyncImagePainter docs. #2711

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions coil-compose-core/src/commonMain/kotlin/coil3/compose/AsyncImagePainter.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,6 @@ import kotlinx.coroutines.launch
/**
* Return an [AsyncImagePainter] that executes an [ImageRequest] asynchronously and renders the result.
*
* ** This is a lower-level API than [AsyncImage] and may not work as expected in all situations. **
*
* @param model Either an [ImageRequest] or the [ImageRequest.data] value.
* @param imageLoader The [ImageLoader] that will be used to execute the request.
* @param placeholder A [Painter] that is displayed while the image is loading.
Expand Down Expand Up @@ -100,8 +98,6 @@ fun rememberAsyncImagePainter(
/**
* Return an [AsyncImagePainter] that executes an [ImageRequest] asynchronously and renders the result.
*
* ** This is a lower-level API than [AsyncImage] and may not work as expected in all situations. **
*
* @param model Either an [ImageRequest] or the [ImageRequest.data] value.
* @param imageLoader The [ImageLoader] that will be used to execute the request.
* @param transform A callback to transform a new [State] before it's applied to the
Expand Down
4 changes: 0 additions & 4 deletions coil-compose/src/commonMain/kotlin/coil3/compose/SingletonAsyncImagePainter.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ import coil3.request.ImageRequest
/**
* Return an [AsyncImagePainter] that executes an [ImageRequest] asynchronously and renders the result.
*
* ** This is a lower-level API than [AsyncImage] and may not work as expected in all situations. **
*
* @param model Either an [ImageRequest] or the [ImageRequest.data] value.
* @param placeholder A [Painter] that is displayed while the image is loading.
* @param error A [Painter] that is displayed when the image request is unsuccessful.
Expand Down Expand Up @@ -58,8 +56,6 @@ fun rememberAsyncImagePainter(
/**
* Return an [AsyncImagePainter] that executes an [ImageRequest] asynchronously and renders the result.
*
* ** This is a lower-level API than [AsyncImage] and may not work as expected in all situations. **
*
* @param model Either an [ImageRequest] or the [ImageRequest.data] value.
* @param transform A callback to transform a new [State] before it's applied to the
* [AsyncImagePainter]. Typically this is used to overwrite the state's [Painter].
Expand Down