Kingfisher README

The project's README from github.com/onevcat/Kingfisher. As one markdown file: README.md.

Kingfisher

Kingfisher is a powerful, pure-Swift library for downloading and caching images from the web. It provides you a chance to use a pure-Swift way to work with remote images in your next app.

Features

Kingfisher 101

The simplest use-case is setting an image to an image view with the UIImageView extension:

import Kingfisher

let url = URL(string: "https://example.com/image.png")
imageView.kf.setImage(with: url)

Kingfisher will download the image from url, send it to both memory cache and disk cache, and display it in imageView. When you set it with the same URL later, the image will be retrieved from the cache and shown immediately.

It also works if you use SwiftUI:

var body: some View {
    KFImage(URL(string: "https://example.com/image.png")!)
}

A More Advanced Example

With the powerful options, you can do hard tasks with Kingfisher in a simple way. For example, the code below:

  1. Downloads a high-resolution image.
  2. Downsamples it to match the image view size.
  3. Makes it round cornered with a given radius.
  4. Shows a system indicator and a placeholder image while downloading.
  5. When prepared, it animates the small thumbnail image with a "fade in" effect.
  6. The original large image is also cached to disk for later use, to get rid of downloading it again in a detail view.
  7. A console log is printed when the task finishes, either for success or failure.
let url = URL(string: "https://example.com/high_resolution_image.png")
let processor = DownsamplingImageProcessor(size: imageView.bounds.size)
             |> RoundCornerImageProcessor(cornerRadius: 20)
imageView.kf.indicatorType = .activity
imageView.kf.setImage(
    with: url,
    placeholder: UIImage(named: "placeholderImage"),
    options: [
        .processor(processor),
        .scaleFactor(UIScreen.main.scale),
        .transition(.fade(1)),
        .cacheOriginalImage
    ])
{
    result in
    switch result {
    case .success(let value):
        print("Task done for: \(value.source.url?.absoluteString ?? "")")
    case .failure(let error):
        print("Job failed: \(error.localizedDescription)")
    }
}

It is a common situation I can meet in my daily work. Think about how many lines you need to write without Kingfisher!

Method Chaining

If you are not a fan of the kf extension, you can also prefer to use the KF builder and chained the method invocations. The code below is doing the same thing:

// Use `kf` extension
imageView.kf.setImage(
    with: url,
    placeholder: placeholderImage,
    options: [
        .processor(processor),
        .loadDiskFileSynchronously,
        .cacheOriginalImage,
        .transition(.fade(0.25)),
        .lowDataMode(.network(lowResolutionURL))
    ],
    progressBlock: { receivedSize, totalSize in
        // Progress updated
    },
    completionHandler: { result in
        // Done
    }
)

// Use `KF` builder
KF.url(url)
  .placeholder(placeholderImage)
  .setProcessor(processor)
  .loadDiskFileSynchronously()
  .cacheMemoryOnly()
  .fade(duration: 0.25)
  .lowDataModeSource(.network(lowResolutionURL))
  .onProgress { receivedSize, totalSize in  }
  .onSuccess { result in  }
  .onFailure { error in }
  .set(to: imageView)

And even better, if later you want to switch to SwiftUI, just change the KF above to KFImage, and you've done:

struct ContentView: View {
    var body: some View {
        KFImage.url(url)
          .placeholder(placeholderImage)
          .setProcessor(processor)
          .loadDiskFileSynchronously()
          .cacheMemoryOnly()
          .fade(duration: 0.25)
          .lowDataModeSource(.network(lowResolutionURL))
          .onProgress { receivedSize, totalSize in  }
          .onSuccess { result in  }
          .onFailure { error in }
    }
}

Requirements

Kingfisher 8.0

Kingfisher 7.0

Installation

Refer to one of the following tutorials to install and use the framework:

Alternatively, you can follow either of the methods below.

Swift Package Manager

CocoaPods

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '13.0'
use_frameworks!

target 'MyApp' do
  pod 'Kingfisher', '~> 8.0'
end

Pre-built Framework

  1. Open the release page, download the latest version of Kingfisher from the assets section.
  2. Drag the Kingfisher.xcframework into your project and add it to the target (usually the app target).
  3. Select your target, in the "General" Tab, find the "Frameworks, Libraries, and Embedded Content" section, set the Embed Without Signing to Kingfisher.

Documentation

Check the documentation and tutorials:

Migrating

If you are using an even earlier version, see the guides below to know the steps for migrating.

Other

Future of Kingfisher

I want to keep Kingfisher lightweight. This framework focuses on providing a simple solution for downloading and caching images. This doesn’t mean the framework can’t be improved. Kingfisher is far from perfect, so necessary and useful updates will be made to make it better.

Developments and Tests

Any contributing and pull requests are warmly welcome. However, before you plan to implement some features or try to fix an uncertain issue, it is recommended to open a discussion first. It would be appreciated if your pull requests could build with all tests green. :)

The logo of Kingfisher is inspired by Tangram (七巧板), a dissection puzzle consisting of seven flat shapes from China. I believe she's a kingfisher bird instead of a swift, but someone insists that she is a pigeon. I guess I should give her a name. Hi, guys, do you have any suggestions?

Contact

Follow and contact me on Twitter or Sina Weibo. If you find an issue, open a ticket. Pull requests are warmly welcome as well.

Backers & Sponsors

Open-source projects cannot live long without your help. If you find Kingfisher to be useful, please consider supporting this project by becoming a sponsor. Your user icon or company logo shows up on my blog with a link to your home page.

Become a sponsor through GitHub Sponsors. :heart:

Special thanks to:

imgly

emergetools

License

Kingfisher is released under the MIT license. See LICENSE for details.

Kingfisher (onevcat/Kingfisher)

Searching Database…

24.4K ·GitHub
Kingfisher
Что это такое?Лёгкая библиотека на чистом Swift для скачивания и кеширования картинок из интернета в приложениях для iOS, macOS, tvOS, watchOS и visionOS — вы даёте ей URL, а она скачивает картинку, кеширует её и показывает.
Это библиотека, которую я добавляю в свой проект Xcode, или отдельное приложение?Это библиотека, которую вы встраиваете в своё приложение, сама по себе она ничего не запускает. Она подключается к элементам вроде UIImageView, NSImageView, UIButton и SwiftUI, так что картинку из интернета можно поставить одной строкой кода.
Как добавить её в проект?Через Swift Package Manager в Xcode (File > Swift Packages > Add Package Dependency, выберите «Up to Next Major» с версией 8.0.0) или через CocoaPods. На странице релизов есть и готовый собранный Kingfisher.xcframework, который просто перетаскивается в ваш таргет.
Какие версии ОС и Swift ей нужны?Kingfisher 8.0 требует iOS 13+, macOS 10.15+, tvOS 13+, watchOS 6+ или visionOS 1+, а также Swift 5.9+. Для SwiftUI требования чуть выше: iOS 14+ / macOS 11+.
Есть ли подводные камни при установке готового фреймворка?Один: после того как вы перетащили Kingfisher.xcframework в свой таргет, нужно выставить для него «Embed Without Signing» на вкладке General, иначе он не попадёт в приложение как следует.
Она работает со SwiftUI или только с UIKit?И с тем, и с другим. Для вьюх UIKit и AppKit есть расширение kf.setImage, для SwiftUI — KFImage, причём синтаксис билдера KF переносится между ними практически без изменений.
Можно ли бесплатно использовать её в своём приложении?Да — библиотека выпущена под лицензией MIT, так что её можно использовать бесплатно, в том числе в коммерческих приложениях.
Что будет, когда я загружаю ту же картинку во второй раз?Она мгновенно отдаётся из кеша. Kingfisher хранит скачанное в многоуровневом гибридном кеше — память плюс диск — и автоматически переиспользует уже загруженные файлы, чтобы не ходить в сеть повторно.
Она умеет что-то ещё, кроме скачивания и показа картинки?Да: в ней есть процессоры и фильтры изображений (уменьшение до размера вьюхи, скругление углов), плейсхолдеры и индикаторы загрузки, анимации переходов, предзагрузка, поддержка Low Data Mode и даже скачивание и кеширование Live Photos.
Мне обязательно использовать её целиком или можно взять только часть с кешированием?Компоненты независимы — загрузчик, систему кеширования и процессоры изображений можно использовать по отдельности, а поведение кеша настраивать своими сроками хранения и лимитами размера.
Почему библиотека называется Kingfisher?Логотип вдохновлён танграмом — китайской головоломкой из семи фигур. Автор настаивает, что это зимородок, а не стриж, — хотя некоторые читатели уверены, что это голубь.
What are similar projects?SDWebImage, AFNetworking, chameleon, FSCalendar, YYKit, SwiftyJSON, Hero, Spring
Which topics is it in?cache, cocoapods, swiftui, image, caching, xcode, apple, image-processing, swift, mobile, ios, framework
Creator
onevcat
Size
7.9 MB
Stars
24.4K
Updated
CommitOct 17Release8.14.0Oct 17
Age
11y
Commits · 90 Days