An image loading library for Android backed by Kotlin Coroutines. Coil is:
- Fast: Coil performs a number of optimizations including memory and disk caching, downsampling the image in memory, re-using bitmaps, automatically pausing/cancelling requests, and more.
- Lightweight: Coil adds ~2000 methods to your APK (for apps that already use OkHttp and Coroutines), which is comparable to Picasso and significantly less than Glide and Fresco.
- Easy to use: Coil's API leverages Kotlin's language features for simplicity and minimal boilerplate.
- Modern: Coil is Kotlin-first and uses modern libraries including Coroutines, OkHttp, Okio, and AndroidX Lifecycles.
Coil is an acronym for: Coroutine Image Loader.
Made with
Download
Coil is available on mavenCentral().
implementation("io.coil-kt:coil:1.1.1")
Quick Start
To load an image into an ImageView, use the load extension function:
// URL
imageView.load("https://www.example.com/image.jpg")
// Resource
imageView.load(R.drawable.image)
// File
imageView.load(File("/path/to/image.jpg"))
// And more...
Requests can be configured with an optional trailing lambda:
imageView.load("https://www.example.com/image.jpg") {
crossfade(true)
placeholder(R.drawable.image)
transformations(CircleCropTransformation())
}
Image Loaders
imageView.load uses the singleton ImageLoader to enqueue an ImageRequest. The singleton ImageLoader can be accessed using an extension function:
val imageLoader = context.imageLoader
Optionally, you can create your own ImageLoader instance(s) and inject them with dependency injection:
val imageLoader = ImageLoader(context)
If you do not want the singleton ImageLoader, depend on io.coil-kt:coil-base.
Requests
To load an image into a custom target, enqueue an ImageRequest:
val request = ImageRequest.Builder(context)
.data("https://www.example.com/image.jpg")
.target { drawable ->
// Handle the result.
}
.build()
val disposable = imageLoader.enqueue(request)
To load an image imperatively, execute an ImageRequest:
val request = ImageRequest.Builder(context)
.data("https://www.example.com/image.jpg")
.build()
val drawable = imageLoader.execute(request).drawable
Check out Coil's full documentation here.
Requirements
- AndroidX
- Min SDK 14+
- Java 8+
R8 / Proguard
Coil is fully compatible with R8 out of the box and doesn't require adding any extra rules.
If you use Proguard, you may need to add rules for Coroutines, OkHttp and Okio.
License
Copyright 2021 Coil Contributors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
![[coil-video] Fails to load preview for video](https://avatars.githubusercontent.com/u/2393864?v=4)
6.3k Dec 27, 2022
102 Dec 22, 2022
1.4k Jan 2, 2023
16.8k Jan 8, 2023
45 Dec 29, 2022
18.4k Jan 6, 2023
9.7k Dec 30, 2022
6.7k Jan 9, 2023
1k Dec 31, 2022
13.1k Jan 7, 2023
10 Dec 11, 2022
24 Nov 18, 2022
6 Dec 23, 2021
13 Dec 29, 2022
5 Mar 5, 2022
16.9k Jan 8, 2023
2.6k Jan 1, 2023