All Versions
Latest Version
Avg Release Cycle
27 days
Latest Release
23 days ago

Changelog History
Page 3

  • v5.8.0 Changes

    May 11, 2020

    ๐Ÿ”‹ Features


    • โž• Add query original cache for transformed image without downloading #2992
    • This can be used to query the original image from cache then do transforming when transformed key cache miss, without any downloading happened.

    Animated Image

    • โž• Added autoplay control property to AnimatedImageView (autoPlayAnimatedImage) #3003


    • ๐Ÿšš Mark the black list formal error code, support remove the failed URL from black list #2997
    • ๐Ÿ’… Polish the error description between image decode failed and image size is 0 #3005


    • โž• Add the convenient request/response modifier, which provide HTTP header directly #2990

    View Category

    • โž• Added the convenient transition options for macOS user. Deprecate the old timingFunction, which can use System API to achieve #2985
    • ๐Ÿ”‹ Feature pass the set operation key into context option from upstream. Fix the potential retain cycle if user use custom manager #2986


    • ๐Ÿ”‹ Feature: Encoding options supports embed thumbnail (works for JPEG/HEIF/AVIF) #2988


    • ๐Ÿ‘Œ Support the SwiftPM Objective-C user to use #improt <SDWebImage/SDWebImage.h> #2987
  • v5.7.4 Changes

    May 06, 2020

    ๐Ÿ›  Fixes

    • ๐Ÿ›  Fix the issue that NSOperation conforms to SDWebImageOperation check failed. Fix cancelling prefetcher hung up #2999 #2998
  • v5.7.3 Changes

    April 21, 2020

    ๐Ÿš€ See all tickets marked for the 5.7.3 release

    ๐Ÿ›  Fixes

    • ๐Ÿ›  Fix the encoding options which does not passthrough the correct value to ImageIO #2989
  • v5.7.2 Changes

    April 11, 2020

    ๐Ÿ›  Fixes

    • SDAnimatedImageView animation rendering should not use CGContext force decoding, use kCGImageSourceShouldCacheImmediately instead which can avoid OOM for large number of GIFs #2977
    • ๐Ÿ›  Fix that when first play animated image and use maxBufferSize to 0, the calculation does not works (The CGImage is nil) #2982


    • ๐Ÿ“‡ Rename the private header UIColor+HexString and NSBezierPath+SDRoundedCorners with SD prefix, to avoid the conflict when using CocoaPods #2983
  • v5.7.1 Changes

    April 08, 2020

    ๐Ÿ›  Fixes

    • Don't copy attributes from originalImage to transformedImage when caching transformedImage #2976. Thanks @bdaz
    • ๐Ÿ›  Fix the wrong value assignment for SDAnimatedImageView code on macOS, warning #2974
  • v5.7.0 Changes

    April 04, 2020

    ๐Ÿ”‹ Features


    • โž• Added the async version API to query disk image data only
    • โž• Added the sync API to query disk image with context and options, which matches the async version


    • ๐Ÿ”‹ Feature supports encoding options like max file size, max pixel size, as well as background color when using JPEG for alpha image #2972
    • ๐Ÿ‘ You can use .encodeMaxFileSize to limit the desired lossy file size, better than compression quality
    • You can use .encodeMaxPixelSize to limit the pixel size, like thumbnail encoding


    • โ™ป๏ธ Refactory the current thumbnail && transformer about cache key. Developer should have the API to calculate the cache key from thumbnail or transformer, not hard-coded. #2966

    Context Option

    • โž• Added new query cache type support, including the SDImageCache API and context option #2968
    • You use .queryCacheType to query image from memory/disk/both cache during image pipeline loading

    ๐Ÿ›  Fixes

    • ๐Ÿ›  Fix the issue for Carthage/SwiftPM framework version symbols, this should match the framework name SDWebImage, or will get a link error when used #2971 #2969
    • Simplify the xattr helper method's code with modern Objective-C syntax #2967. Thanks @huangboju

    ๐Ÿ”„ Changes

    • ๐Ÿ”„ Change the behavior to return the abstract type for unknown image format, this can solve the accident issue for custom coder who provide a new format #2973
  • v5.6.1 Changes

    March 13, 2020

    ๐ŸŽ Performances

    • Keep the progressive decoding process only exist one per image download. Cancel the unused progressive decoding when full pixel data is available. #2483

    ๐Ÿ›  Fixes

    • ๐Ÿ›  Fix the NotificationCenter does not remove the observer and little private header garden #2959
  • v5.6.0 Changes

    March 05, 2020

    ๐Ÿ”‹ Features

    URLSession Metrics

    • โž• Added the URLSessionTaskMetrics support for downloader && operation, which can be used for network metrics #2937
    • Typically you use custom operation class to collect all metrics in your app. You can also collect metrics for single url request level. Check the #2937 example code to grab the download token and check metrics.

    Vector Image

    • ๐Ÿ”‹ Feature - better support for vector format detection, now PDF rasterized bitmap is built-in #2936
    • Pass .thumbnailPixelSize to control the PDF bitmap size. If you want vector PDF rendering, you still need to use SDWebImagePDFCoder.
    • Vector image like SVG (via SDWebImageSVGCoder) and PDF (via SDWebImagePDFCoder), or system symbol images, can be detected by new API sd_isVector.
    • 0๏ธโƒฃ Vector image does not pass to transformer by default, because they support dynamic size changing. Pass .transformVectorImage option to allow transformation.


    • โž• Add a better check to handle the cases when call storeImage without imageData #2953
    • Which means, if you store image to disk without data, we will use extra information via sd_imageFormat or custom image class, to choose the the image format (including GIF and PDF) for encoding. Previously we only encode it into PNG or JPEG.

    Context Option

    • ๐Ÿ”‹ Feature add context option for cache, loader and coder, deprecated SDWebImageContextCustomManager #2955
    • This makes it easy to use custom loader, cache, and decoder, without need to create a dummy SDWebImageManager instance.

    ๐Ÿ›  Fixes

    • ๐Ÿ›  Fix the rare case when call SDWebImageDownloaderOperation.cancel, the completion block may callback twice #2954

    โš  Warnings

    • ๐Ÿš€ Suppress the deprecation warning when min deployment target version set to iOS 13+ or macCatalyst
    • Complete all the SDWebImage error code with the localized description, make it easy for debugging #2948
  • v5.5.2 Changes

    January 26, 2020

    ๐Ÿš€ See all tickets marked for the 5.5.2 release

    ๐Ÿ›  Fixes

    • ๐Ÿ›  Fix the issue that maxBufferSize property does not correctlly works for SDAnimatedImageView #2934
  • v5.5.1 Changes

    January 18, 2020

    ๐Ÿš€ See all tickets marked for the 5.5.1 release

    ๐Ÿ›  Fixes

    • ๐Ÿ›  Fix the SDAnimatedImageView's progressive animation bug, which reset the frame index to 0 each time new frames available #2931