Asynchronous image downloader with cache support as a UIImageView category
This library provides an async image downloader with cache support. For convenience, we added categories for UI elements like
MKAnnotationViewadding web image and cache management
In order to keep SDWebImage focused and limited to the core features, but also allow extensibility and custom behaviors, during the 5.0 refactoring we focused on modularizing the library. As such, we have moved/built new modules to SDWebImage org.
SwiftUI is an innovative UI framework written in Swift to build user interfaces across all Apple platforms.
We support SwiftUI by building a brand new framework called SDWebImageSwiftUI, which is built on top of SDWebImage core functions (caching, loading and animation).
The new framework introduce two View structs
AnimatedImagefor SwiftUI world,
ImageIndicatormodifier for any View,
ImageManagerobservable object for data source. Supports iOS 13+/macOS 10.15+/tvOS 13+/watchOS 6+ and Swift 5.1. Have a nice try and provide feedback!
You can use those directly, or create similar components of your own, by using the customizable architecture of SDWebImage.
pod try SDWebImage
#import ... [imageView sd_setImageWithURL:[NSURL URLWithString:@"http://www.domain.com/path/to/image.jpg"] placeholderImage:[UIImage imageNamed:@"placeholder.png"]];
imageView.sd_setImage(with: URL(string: "http://www.domain.com/path/to/image.jpg"), placeholderImage: UIImage(named: "placeholder.png"))
In 5.0, we introduced a brand new mechanism for supporting animated images. This includes animated image loading, rendering, decoding, and also supports customizations (for advanced users).
This animated image solution is available for
SDAnimatedImageis subclass of
SDAnimatedImageViewis subclass of
UIImageView/NSImageView, to make them compatible with the common frameworks APIs.
SDAnimatedImageViewsupports the familiar image loading category methods, works like drop-in replacement for
Don't have UIView (like WatchKit or CALayer)? you can still use
SDAnimatedPlayerthe player engine for advanced playback and rendering.
See Animated Image for more detailed information.
SDAnimatedImageView *imageView = [SDAnimatedImageView new]; SDAnimatedImage *animatedImage = [SDAnimatedImage imageNamed:@"image.gif"]; imageView.image = animatedImage;
let imageView = SDAnimatedImageView() let animatedImage = SDAnimatedImage(named: "image.gif") imageView.image = animatedImage
In order to clean up things and make our core project do less things, we decided that the
FLAnimatedImageintegration does not belong here. From 5.0, this will still be available, but under a dedicated repo SDWebImageFLPlugin.
There are four ways to use SDWebImage in your project: - using CocoaPods - using Carthage - using Swift Package Manager - manual install (build frameworks or embed Xcode Project)
platform :ios, '8.0' pod 'SDWebImage', '~> 5.0'
Swift project previously have to use
use_frameworks!to make all Pods into dynamic framework to let CocoaPods works.
However, start with
Xcode 9+), which supports to build both Objective-C && Swift code into static framework. You can use modular headers to use SDWebImage as static framework, without the need of
platform :ios, '8.0' # Uncomment the next line when you want all Pods as static framework # use_modular_headers! pod 'SDWebImage', :modular_headers => true
See more on CocoaPods 1.5.0 — Swift Static Libraries
If not, you still need to add
use_frameworks!to use SDWebImage as dynamic framework:
platform :ios, '8.0' use_frameworks! pod 'SDWebImage'
There are 2 subspecs available now:
MapKit(this means you can install only some of the SDWebImage modules. By default, you get just
Core, so if you need
MapKit, you need to specify it).
Carthage is a lightweight dependency manager for Swift and Objective-C. It leverages CocoaTouch modules and is less invasive than CocoaPods.
To install with carthage, follow the instruction on Carthage
Carthage users can point to this repository and use whichever generated framework they'd like: SDWebImage, SDWebImageMapKit or both.
Make the following entry in your Cartfile:
github "SDWebImage/SDWebImage"Then run
carthage updateIf this is your first time using Carthage in the project, you'll need to go through some additional steps as explained over at Carthage.
NOTE: At this time, Carthage does not provide a way to build only specific repository subcomponents (or equivalent of CocoaPods's subspecs). All components and their dependencies will be built with the above command. However, you don't need to copy frameworks you aren't using into your project. For instance, if you aren't usingSDWebImageMapKit, feel free to delete that framework from the Carthage Build directory aftercarthage updatecompletes.
Swift Package Manager (SwiftPM) is a tool for managing the distribution of Swift code as well as C-family dependency. From Xcode 11, SwiftPM got natively integrated with Xcode.
SDWebImage support SwiftPM from version 5.1.0. To use SwiftPM, you should use Xcode 11 to open your project. Click
Add Package Dependency, enter SDWebImage repo's URL. Or you can login Xcode with your GitHub account and just type
After select the package, you can choose the dependency type (tagged version, branch or commit). Then Xcode will setup all the stuff for you.
If you're a framework author and use SDWebImage as a dependency, update your
let package = Package( // 5.1.0 ..< 6.0.0 dependencies: [ .package(url: "https://github.com/SDWebImage/SDWebImage.git", from: "5.1.0") ], // ... )
See more on Manual install Guide
In the source files where you need to use the library, import the umbrella header file:
It's also recommend to use the module import syntax, available for CocoaPods(enable
At this point your workspace should build without error. If you are having problem, post to the Issue and the community can help you solve it.
Thank you to all the people who have already contributed to SDWebImage.
All source code is licensed under the MIT License.
To learn about SDWebImage's architecture design for contribution, read The Core of SDWebImage v5.6 Architecture. Thanks @looseyi for the post and translation.