6.0.0 - New Year 2021

Add

• A KF shorthand to create image setting tasks and config them. It provides a cleaner and modern way to use Kingfisher. Now, instead of using imageView.kf.setImage(with:options:), you can perform chain-able invocation with KF helpers. For example, the code below is identical. #1546

  // Old way
  imageView.kf.setImage(
    with: url,
    placeholder: localImage,
    options: [.transition(.fade(1)), .loadDiskFileSynchronously],
    progressBlock: { receivedSize, totalSize in
        print("progressBlock")
    },
    completionHandler: { result in
        print(result)
    }
  )
  
  // New way
  KF.url(url)
    .placeholder(localImage)
    .fade(duration: 1)
    .loadDiskFileSynchronously()
    .onProgress { _ in print("progressBlock") }
    .onSuccess { result in print(result) }
    .onFailure { err in print("Error: \(err)") }
    .set(to: imageView)

• Similar to KF, The KFImage for SwiftUI is now having the similar chain-able syntax to setup an image task and options. This makes the KFImage APIs closer to the way how SwiftUI code is written. #1586

• Add support for TVMonogramView on tvOS. #1571

• Some important properties and method in AnimatedImageView.Animator are marked as public now. It provides some useful information of the decoded GIF files. #1575

• An AsyncImageDownloadRequestModifier to support modifying the request in an asynchronous way. #1589

• Add a .lowDataMode option to support for Low Data Mode. When the .lowDataMode option is provided with an alternative source (usually a low-resolution version of the original image), Kingfisher will respect user's Low Data Mode setting and download the alternative image instead. #1590

Fix

• An issue that importing AppKit wrongly in a macCatalyst build. #1547

Remove

• Deprecated types, methods and properties are removed. If you are still using Kingfisher.Image, Kingfisher.ImageView or Kingfisher.Button, use the equivalent KFCrossPlatform types (such as KFCrossPlatformImage, etc) instead. Please make sure you do not have any warnings before migrate to Kingfisher v6. For more about the removed deprecated things, check #1525.
• The standalone framework target of SwiftUI support is removed. Now the SwiftUI support is a part in the main Kingfisher library. To upgrade to v6, first remove Kingfisher/SwiftUI subpod (if you are using CocoaPods) or remove the KingfisherSwiftUI target (if you are using Carthage or Swift Package Manager), then reinstall Kingfisher. #1574

5.15.8 - KFImage handler

Fix

• An issue caused the onSuccess handler not be called when the image is already cached. #1570

5.15.7 - Cancel Lock

Fix

• A potential crash when cancelling image downloading task while accessing its original request on iOS 13 or earlier. #1558

5.15.6 - ImageBinder Callback

Fix

• Prevent main queue dispatching in ImageBinder if it is already on main thread. This prevents unintended flickering when reloading. #1551

5.15.5 - Cancelling Fix

Fix

• A possible fix for the crashes when cancelling a huge amount of image tasks too fast. [#1537]

5.15.4 - Farewell Objective-C (CocoaPods)

Fix

• Give SessionDelegate an Objective-C name so it can work with other libraries even added by a dependency which generates Objective-C header. #1532

5.15.3 - Farewell Objective-C

Fix

• Removed the unnecessary ObjC header generating and module defining due to Xcode 12 is now generating conflicted types even for different libraries. #1517
• Set deploy target for SwiftUI target and its pod spec to iOS 10 and macOS 10.12, which aligns to the settings of core framework. That resolves some dependency issues when using CocoaPods for both app target and extension targets. But it does not mean you can use the SwiftUI support on those minimal target. All related APIs are still unavailable on old system versions. #1524

5.15.2 - Xcode 11 Revived

Fix

• Fix a build error introduced by the previous SwiftUI fix for Xcode 12. Now Xcode 11 can also build the KingfisherSwiftUI target. #1515

5.15.1 - SwiftUI Layout

Fix

• A workaround for a SwiftUI issue that embedding an image view inside the List > NavigationLink > HStack hierarchy could crash the app on iOS 14. #1508

5.15.0 - Video and Text Attachment

Add

• An AVAssetImageDataProvider to generate an image from a remote video asset at a specified time. All the processing gets benefits from current existing Kingfisher technologies, such as cache and image processors. #1500
• New extension methods on NSTextAttachment to load an image from network for an attachment. #1495
• A general clear cache method which combines clearing for memory cache and disk cache. #1494

Fix

• Now the sample app has a new look and supports dark mode, finally. #1496