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
- An asynchronous image downloader
- An asynchronous memory + disk image caching with automatic cache expiration handling
- A background image decompression
- A guarantee that the same URL won't be downloaded several times
- A guarantee that bogus URLs won't be retried again and again
- A guarantee that main thread will never be blocked
- Use GCD and ARC
Supported Image Formats
- Image formats supported by UIImage (JPEG, PNG, ...), including GIF
- WebP format, including animated WebP (use the
- Support extendable coder plugins for new image formats. Like APNG, BPG, HFIF, SVG, etc. See all the list in Image coder plugin List
SDWebImage's 5.0 version is nearing completion. Which introduce many new features like Animated ImageView and Transformer. We also provide a more modularized design used for advanced user customization.
You can check the latest 5.x branch to know about the current status. We'd love you to have a try with the beta version and provide any feedback. If you'd love, check SDWebImage 5.0 Migration Guide and prepare for the migration.
- iOS 7.0 or later
- tvOS 9.0 or later
- watchOS 2.0 or later
- macOS 10.9 or later
- Xcode 7.3 or later
- Read this Readme doc
- Read the How to use section
- Read the Documentation @ CocoaDocs
- Try the example by downloading the project from Github or even easier using CocoaPods try
pod try SDWebImage
- Read the Installation Guide
- Read the SDWebImage 4.0 Migration Guide to get an idea of the changes from 3.x to 4.x
- Read the Common Problems to find the solution for common problems
- Go to the Wiki Page for more information such as Advanced Usage
Who Uses It
- Find out who uses SDWebImage and add your app to the list.
- If you need help, use Stack Overflow. (Tag 'sdwebimage')
- If you'd like to ask a general question, use Stack Overflow.
- If you found a bug, open an issue.
- If you have a feature request, open an issue.
- If you want to contribute, submit a pull request.
How To Use
#import <SDWebImage/UIImageView+WebCache.h> ... [imageView sd_setImageWithURL:[NSURL URLWithString:@"http://www.domain.com/path/to/image.jpg"] placeholderImage:[UIImage imageNamed:@"placeholder.png"]];
import SDWebImage imageView.sd_setImage(with: URL(string: "http://www.domain.com/path/to/image.jpg"), placeholderImage: UIImage(named: "placeholder.png"))
- For details about how to use the library and clear examples, see The detailed How to use
Animated Images (GIF) support
- Starting with the 4.0 version, we rely on FLAnimatedImage to take care of our animated images.
- If you use cocoapods, add
pod 'SDWebImage/GIF'to your podfile.
- To use it, simply make sure you use
Note: there is a backwards compatible feature, so if you are still trying to load a GIF into a
UIImageView, it will only show the 1st frame as a static image by default. However, you can enable the full GIF support by using the built-in GIF coder. See GIF coder
Important: FLAnimatedImage only works on the iOS platform. For macOS, use
YESto show the entire animated images and
NOto only show the 1st frame. For all the other platforms (tvOS, watchOS) we will fallback to the backwards compatibility feature described above
There are three ways to use SDWebImage in your project:
- using CocoaPods
- using Carthage
- by cloning the project into your repository
Installation with CocoaPods
platform :ios, '7.0' pod 'SDWebImage', '~> 4.0'
Swift and static framework
Swift project previously have to use
use_frameworks! to make all Pods into dynamic framework to let CocoaPods works.
However, start with
CocoaPods 1.5.0+ (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 4 subspecs available now:
WebP (this means you can install only some of the SDWebImage modules. By default, you get just
Core, so if you need
WebP, you need to specify it).
Installation with Carthage (iOS 8+)
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
Installation by cloning the repository
- see Manual install
Import headers in your source files
In the source files where you need to use the library, import the header file:
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.
All source code is licensed under the MIT License.