Skip to content

README ru

Coil

Библиотека для загрузки изображений на Android, работающая с корутинами Kotlin. Coil - это:

  • Скорость: Coil выполняет оптимизации, включая кэширование в памяти и на диске, уменьшение дискретизации изображения в памяти, автоматическая приостановка/отмена запросов, и многое другое.
  • Маленький вес: Coil добавляет ~2000 методов в ваш APK (для приложений, уже пользующихся OkHttp и корутинами), что сравнимо с Picasso и гораздо меньше, чем Glide и Fresco.
  • Простота в использовании: API Coil использует преимущества Kotlin, чтобы уменьшить количество повторяющегося кода.
  • Современность: Coil в первую очередь предназначен для Kotlin и использует современные библиотеки, включая корутины, OkHttp, Okio, и AndroidX Lifecycles.

Coil - аббревиатура: Coroutine Image Loader (загрузчик изображений при помощи корутин).

Установка

Coil доступен в mavenCentral().

implementation("io.coil-kt:coil:2.6.0")

Начало работы

ImageViews

Чтобы загрузить изображение в ImageView, воспользуйтесь расширением load:

// URL
imageView.load("https://example.com/image.jpg")

// Файл
imageView.load(File("/path/to/image.jpg"))

// И многое другое...

Запросы могут конфигурироваться лямбда-функцией:

imageView.load("https://example.com/image.jpg") {
    crossfade(true)
    placeholder(R.drawable.image)
    transformations(CircleCropTransformation())
}

Jetpack Compose

Установите библиотеку-расширение для Jetpack Compose:

implementation("io.coil-kt:coil-compose:2.6.0")

Чтобы загрузить изображение, воспользуйтесь composable-функцией AsyncImage:

AsyncImage(
    model = "https://example.com/image.jpg",
    contentDescription = null,
)

Загрузчики изображений

Как imageView.load, так и AsyncImage используют синглтон ImageLoader для исполнения запросов на загрузку. Синглтон ImageLoader доступен через расширение Context:

val imageLoader = context.imageLoader

ImageLoaderы максимально эффективны, когда во всем приложении используется один и тот же его экземпляр. Тем не менее, вы можете создавать и свои экземпляры ImageLoader, если потребуется:

val imageLoader = ImageLoader(context)

Если вам не требуется синглтон ImageLoader, используйте io.coil-kt:coil-base вместо io.coil-kt:coil.

Запросы

Чтобы загрузить изображение в заданную цель, выполните метод enqueue на ImageRequest:

val request = ImageRequest.Builder(context)
    .data("https://example.com/image.jpg")
    .target { drawable ->
        // Распоряжайтесь результатом.
    }
    .build()
val disposable = imageLoader.enqueue(request)

Чтобы загрузить изображение императивно, выполните execute на ImageRequest:

val request = ImageRequest.Builder(context)
    .data("https://example.com/image.jpg")
    .build()
val drawable = imageLoader.execute(request).drawable

Полную документацию для Coil можно найти здесь.

R8 / Proguard

Coil полностью совместим с R8 "из коробки" и не требует дополнительной настройки.

Если вы используете Proguard, вам может понадобиться добавить правила для корутин и OkHttp.

Лицензия

Copyright 2023 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.