Repository files navigation

This library provides an async image downloader with cache support. For convenience, we added categories for UI elements likeUIImageView,UIButton,MKAnnotationView.

💡NOTE:SD is the prefix forSimple Design (which is the team name in Daily Motion company from the author Olivier Poitrey)

• Categories forUIImageView,UIButton,MKAnnotationView adding web image and cache management
• An asynchronous image downloader
• An asynchronous memory + disk image caching with automatic cache expiration handling
• A background image decompression to avoid frame rate drop
• Progressive image loading (including animated image, like GIF showing in Web browser)
• Thumbnail image decoding to save CPU && Memory for large images
• Extendable image coder to support massive image format, like WebP
• Full-stack solution for animated images which keep a balance between CPU && Memory
• Customizable and composable transformations can be applied to the images right after download
• Customizable and multiple caches system
• Customizable and multiple loaders system to expand the capabilities, likePhotos Library
• Image loading indicators
• Image loading transition animation
• 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
• Modern Objective-C and better Swift support
• Performances!

From 5.19+, SDWebImage supports visionOS on all Package Managers (include CocoaPods/Carthage/SPM). Upgrade the related tools if you're facing issues.

For 5.18+, SDWebImage can be compiled for visionOS platform. However, it's still in beta and may contains issues unlike the stable iOS UIKit support. Welcome to have a try andreport issue.

To build on visionOS, currently we only support the standard Xcode integration.

SeeInstallation with Swift Package Manager andManual Installation Guide below.

• Image formats supported by Apple system (JPEG, PNG, TIFF, BMP, ...), includingGIF/APNG animated image
• HEIC format from iOS 11/macOS 10.13, including animated HEIC from iOS 13/macOS 10.15 viaSDWebImageHEICCoder. For lower firmware, use coder pluginSDWebImageHEIFCoder
• WebP format from iOS 14/macOS 11.0 viaSDWebImageAWebPCoder. For lower firmware, use coder pluginSDWebImageWebPCoder
• JPEG-XL format from iOS 17/macOS 14.0 built-in. For lower firmware, use coder pluginSDWebImageJPEGXLCoder
• Support extendable coder plugins for new image formats like BPG, AVIF. And vector format like PDF, SVG. See all the list inImage coder plugin List

💡NOTE: For new user

SDWebImage useCoder Plugin System to support both Apple's built-in and external image format. For static image we always use Apple's built-in as fallback, but not for animated image. Currently (updated to 5.19.x version) we only register traditional animated format like GIF/APNG by default, without the modern format like AWebP/HEICS/AVIF, even on the latest firmware.

If you want these animated image format support, simply register by yourself with one-line code, see more inWebP Coder andHEIC Coder

In future we will change this behavior by always registering all Apple's built-in animated image format, to make it easy for new user to integrate.

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 toSDWebImage 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 calledSDWebImageSwiftUI, which is built on top of SDWebImage core functions (caching, loading and animation).

The new framework introduce two View structsWebImage andAnimatedImage for SwiftUI world,ImageIndicator modifier for any View,ImageManager observable 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!

• SDWebImageWebPCoder - coder for WebP format. iOS 9+/macOS 10.11+. Based onlibwebp
• SDWebImageHEIFCoder - coder for HEIF format, iOS 9+/macOS 10.11+ support. Based onlibheif
• SDWebImageBPGCoder - coder for BPG format. Based onlibbpg
• SDWebImageFLIFCoder - coder for FLIF format. Based onlibflif
• SDWebImageAVIFCoder - coder for AVIF (AV1-based) format. Based onlibavif
• SDWebImagePDFCoder - coder for PDF vector format. Using built-in frameworks
• SDWebImageSVGCoder - coder for SVG vector format. Using built-in frameworks
• SDWebImageSVGNativeCoder - coder for SVG-Native vector format. Based onsvg-native
• SDWebImageLottieCoder - coder for Lottie animation format. Based onrlottie
• SDWebImageJPEGXLCoder - coder for JPEG-XL format. iOS 9+/macOS 10.11+. Based onlibjxl
• and more from community!

• SDWebImageYYPlugin - plugin to support caching images withYYCache
• SDWebImagePINPlugin - plugin to support caching images withPINCache

• SDWebImagePhotosPlugin - plugin to support loading images from Photos (usingPhotos.framework)
• SDWebImageLinkPlugin - plugin to support loading images from rich link url, as well asLPLinkView (usingLinkPresentation.framework)

• SDWebImageLottiePlugin - plugin to supportLottie-iOS, vector animation rending with remote JSON files
• SDWebImageSVGKitPlugin - plugin to supportSVGKit, SVG rendering using Core Animation, iOS 9+/macOS 10.11+ support
• SDWebImageFLPlugin - plugin to supportFLAnimatedImage as the engine for animated GIFs
• SDWebImageYYPlugin - plugin to integrateYYImage &YYCache for image rendering & caching

• FirebaseUI - Firebase Storage binding for query images, based on SDWebImage loader system
• react-native-fast-image - React Native fast image component, based on SDWebImage Animated Image solution
• flutter_image_compress - Flutter compresses image plugin, based on SDWebImage WebP coder plugin

• libwebp-Xcode - A wrapper forlibwebp + an Xcode project.
• libheif-Xcode - A wrapper forlibheif + an Xcode project.
• libavif-Xcode - A wrapper forlibavif + an Xcode project.
• and more third-party C/C++ image codec libraries with CocoaPods/Carthage/SwiftPM support.

You can use those directly, or create similar components of your own, by using the customizable architecture of SDWebImage.

• iOS 9.0 or later
• tvOS 9.0 or later
• watchOS 2.0 or later
• macOS 10.11 or later (10.15 for Catalyst)
• visionOS 1.0 or later
• Xcode 15.0 or later

• For iOS 8, macOS 10.10 or Xcode < 11, useany 5.x version up to 5.9.5
• For iOS 7, macOS 10.9 or Xcode < 8, useany 4.x version up to 4.4.6
• For macOS 10.8, useany 4.x version up to 4.3.0
• For iOS 5 and 6, useany 3.x version up to 3.7.6
• For iOS < 5.0, please use the last2.0 version.

• Read this Readme doc
• Read theHow to use section
• Read theLatest Documentation andCocoaDocs for old version
• Try the example by downloading the project from Github or even easier using CocoaPods trypod try SDWebImage
• Read theInstallation Guide
• Read theSDWebImage 5.0 Migration Guide to get an idea of the changes from 4.x to 5.x
• Read theSDWebImage 4.0 Migration Guide to get an idea of the changes from 3.x to 4.x
• Read theCommon Problems to find the solution for common problems
• Go to theWiki Page for more information such asAdvanced Usage

• Find outwho uses SDWebImage and add your app to the list.

• If youneed help, useStack Overflow. (Tag 'sdwebimage')
• If you'd like toask a general question, useStack Overflow.
• If youfound a bug, open an issue.
• If youhave a feature request, open an issue.
• If youneed IRC channel, useGitter.

• If youwant to contribute, read theContributing Guide
• Fordevelopment contribution guide, read theHow-To-Contribute
• Forunderstanding code architecture, read theCode Architecture Analysis

• Objective-C

#import<SDWebImage/SDWebImage.h>...[imageViewsd_setImageWithURL:[NSURLURLWithString:@"http://www.domain.com/path/to/image.jpg"]placeholderImage:[UIImageimageNamed:@"placeholder.png"]];

• Swift

import SDWebImageimageView.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, seeThe detailed How to use

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 foriOS/tvOS/macOS. TheSDAnimatedImage is subclass ofUIImage/NSImage, andSDAnimatedImageView is subclass ofUIImageView/NSImageView, to make them compatible with the common frameworks APIs.

TheSDAnimatedImageView supports the familiar image loading category methods, works like drop-in replacement forUIImageView/NSImageView.

Don't haveUIView (likeWatchKit orCALayer)? you can still useSDAnimatedPlayer the player engine for advanced playback and rendering.

SeeAnimated Image for more detailed information.

• Objective-C

SDAnimatedImageView *imageView = [SDAnimatedImageViewnew];SDAnimatedImage *animatedImage = [SDAnimatedImageimageNamed:@"image.gif"];imageView.image = animatedImage;

• Swift

letimageView=SDAnimatedImageView()letanimatedImage=SDAnimatedImage(named:"image.gif")imageView.image= animatedImage

In order to clean up things and make our core project do less things, we decided that theFLAnimatedImage integration does not belong here. From 5.0, this will still be available, but under a dedicated repoSDWebImageFLPlugin.

There are 5 ways to use SDWebImage in your project:

• using CocoaPods
• using Carthage
• using Swift Package Manager
• download binary XCFramework
• manual install (build frameworks or embed Xcode Project)

CocoaPods is a dependency manager for Objective-C, which automates and simplifies the process of using 3rd-party libraries in your projects. See theGet Started section for more details.

platform :ios, '8.0'pod 'SDWebImage', '~> 5.0'

Swift project previously had to useuse_frameworks! to make all Pods into dynamic framework to let CocoaPods work.

However, starting withCocoaPods 1.5.0+ (withXcode 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 ofuse_frameworks!:

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 onCocoaPods 1.5.0 — Swift Static Libraries

If not, you still need to adduse_frameworks! to use SDWebImage as dynamic framework:

platform :ios, '8.0'use_frameworks!pod 'SDWebImage'

There are 2 subspecs available now:Core andMapKit (this means you can install only some of the SDWebImage modules. By default, you get justCore, so if you needMapKit, you need to specify it).

Podfile example:

pod 'SDWebImage/MapKit'

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 onCarthage

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 runcarthage updateIf this is your first time using Carthage in the project, you'll need to go through some additional steps as explainedover 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 update completes.

💡NOTE:Apple requires SDWebImage contains signatures. So, by default thecarthage build binary framework does not do codesign, this will cause validation error. You can sign yourself with the Apple Developer Program identity, or using the binary framework:

binary "https://github.com/SDWebImage/SDWebImage/raw/master/SDWebImage.json"

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. ClickFile ->Swift Packages ->Add Package Dependency, enterSDWebImage repo's URL. Or you can login Xcode with your GitHub account and just typeSDWebImage to search.

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 yourPackage.swift file:

letpackage=Package(    // 5.1.0 ..< 6.0.0    dependencies:[.package(url:"https://github.com/SDWebImage/SDWebImage.git", from:"5.1.0")],    // ...)

From 5.19.2, SDWebImage provide the canonical official binary XCFramework onGitHub release pages.

• Download XCFramework

You can choose to downloadSDWebImage-dynamic.xcframework.zip for dynamic linked one, orSDWebImage-static.xcframework.zip for static-linked one.

• Integrate to Xcode Project

Drag the unzipped.xcframework into your Xcode Project's Framework tab.

• Verify signature of binary XCFramework

From Xcode 15 Apple will verify the signature of binary XCFramework, to avoid supply chain attack.

The fingerprint currently should beFC 3B 10 13 86 34 4C 50 DB 70 2A 9A D1 01 6F B5 1A 3E CC 8B 9D A9 B7 AE 47 A0 48 D4 D0 63 39 83

The certificate is stored in the repohere

The public key is stored in the repohere

See more:Verifying the origin of your XCFrameworks

• Check your command line Xcode version

sudo xcode-select -s /path/to/Xcode.app

or

export DEVELOPER_DIR=/path/to/Xcode.app/Contents/Developer

• Run the script to build frameworks

./Scripts/build-frameworks.sh

• Run the script to merge XCFramework

./Scripts/create-xcframework.sh

• Use your own certificate to sign XCFramework

// https://developer.apple.com/support/third-party-SDK-requirements/codesign --timestamp -v --sign "your own certificate" SDWebImage.xcframework

See more on wiki:Manual install Guide

In the source files where you need to use the library, import the umbrella header file:

#import<SDWebImage/SDWebImage.h>

It's also recommend to use the module import syntax, available for CocoaPods(enablemodular_headers)/Carthage/SwiftPM.

@import SDWebImage;

At this point your workspace should build without error. If you are having problem, post to the Issue and thecommunity can help you solve it.

From Xcode 15, we provide the newPrivacyInfo.xcprivacy file for privacy details, seeDescribing data use in privacy manifests

You can exports the privacy report after archive your App by integrate SDWebImage via SwiftPM/XCFramework or CocoaPods (use_frameworks set to true).

For old version or if you're using static ar archive, as required by theApp privacy details on the App Store, here's SDWebImage's list ofData Collection Practices.

• Olivier Poitrey

• Konstantinos K.
• Bogdan Poplauschi
• Chester Liu
• DreamPiggy
• Wu Zhong

Thank you to all the people who have already contributed to SDWebImage.

All source code is licensed under theMIT License.

To learn about SDWebImage's architecture design for contribution, readThe Core of SDWebImage v5.6 Architecture. Thanks @looseyi for the post and translation.

• Manager API Diagram
• Coders API Diagram
• Loader API Diagram
• Cache API Diagram