Latest 5.0.5
Homepage https://github.com/SDWebImage/SDWebImage
License MIT
Platforms osx 10.10, ios 8.0, tvos 9.0, watchos 2.0, requires ARC
Frameworks ImageIO
Authors

Build Status
Pod Version
Pod Platform
Pod License
Carthage compatible
codecov

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

Features

Supported Image Formats

  • Image formats supported by UIImage (JPEG, PNG, …), including GIF
  • WebP format, including animated WebP (use the SDWebImageWebPCoder project)
  • Support extendable coder plugins for new image formats. Like APNG, BPG, HFIF, SVG, etc. See all the list in Image coder plugin List

Additional modules

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.

Coders for additional image formats

Loaders

Integration with 3rd party libraries

Make our lives easier

  • libwebp-Xcode – A wrapper for libwebp + an Xcode project.
  • libheif-Xcode – A wrapper for libheif + an Xcode project.
  • and more third-party C/C++ image codec libraries with CocoaPods/Carthage support.

You can use those directly, or create similar components of your own.

Requirements

  • iOS 8.0 or later
  • tvOS 9.0 or later
  • watchOS 2.0 or later
  • macOS 10.10 or later
  • Xcode 9.0 or later

Backwards compatibility

Getting Started

Who Uses It

Communication

  • 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, read the Contributing Guide

How To Use

  • Objective-C
#import <SDWebImage/SDWebImage.h>
...
[imageView sd_setImageWithURL:[NSURL URLWithString:@"http://www.domain.com/path/to/image.jpg"]
             placeholderImage:[UIImage imageNamed:@"placeholder.png"]];
  • Swift
import SDWebImage

imageView.sd_setImage(with: URL(string: "http://www.domain.com/path/to/image.jpg"), placeholderImage: UIImage(named: "placeholder.png"))

Animated Images (GIF) support

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 iOS/tvOS/macOS. The SDAnimatedImage is subclass of UIImage/NSImage, and SDAnimatedImageView is subclass of UIImageView/NSImageView, to make them compatible with the common frameworks APIs. See Animated Image for more detailed information.

FLAnimatedImage integration has its own dedicated repo

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

Installation

There are three ways to use SDWebImage in your project:

  • using CocoaPods
  • using Carthage
  • by cloning the project into your repository

Installation with CocoaPods

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

Podfile

platform :ios, '8.0'
pod 'SDWebImage', '~> 5.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 use_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 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'

Subspecs

There are 2 subspecs available now: Core and 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).

Podfile example:

pod 'SDWebImage/MapKit'

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

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 update
If 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 using SDWebImageMapKit, feel free to delete that framework from the Carthage Build directory after carthage update completes.

Installation by cloning the repository

Import headers in your source files

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

#import <SDWebImage/SDWebImage.h>

Build Project

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.

Author

Collaborators

Licenses

All source code is licensed under the MIT License.

Architecture

High Level Diagram

Overall Class Diagram

Top Level API Diagram

Main Sequence Diagram

More detailed diagrams

Latest podspec

{
    "name": "SDWebImage",
    "version": "5.0.5",
    "platforms": {
        "osx": "10.10",
        "ios": "8.0",
        "tvos": "9.0",
        "watchos": "2.0"
    },
    "license": "MIT",
    "summary": "Asynchronous image downloader with cache support with an UIImageView category.",
    "homepage": "https://github.com/SDWebImage/SDWebImage",
    "authors": {
        "Olivier Poitrey": "[email protected]"
    },
    "source": {
        "git": "https://github.com/SDWebImage/SDWebImage.git",
        "tag": "5.0.5"
    },
    "description": "This library provides a category for UIImageView with support for remote images coming from the web. It provides an UIImageView category adding web image and cache management to the Cocoa Touch framework, an asynchronous image downloader, an asynchronous memory + disk image caching with automatic cache expiration handling, a guarantee that the same URL won't be downloaded several times, a guarantee that bogus URLs won't be retried again and again, and performances!",
    "requires_arc": true,
    "frameworks": "ImageIO",
    "module_map": "WebImage/SDWebImage.modulemap",
    "default_subspecs": "Core",
    "subspecs": [
        {
            "name": "Core",
            "source_files": [
                "SDWebImage/*.{h,m}",
                "WebImage/SDWebImage.h",
                "SDWebImage/Private/*.{h,m}"
            ],
            "exclude_files": "SDWebImage/MapKit/*.{h,m}",
            "private_header_files": "SDWebImage/Private/*.h"
        },
        {
            "name": "MapKit",
            "platforms": {
                "osx": "10.10",
                "ios": "8.0",
                "tvos": "9.2"
            },
            "source_files": "SDWebImage/MapKit/*.{h,m}",
            "frameworks": "MapKit",
            "dependencies": {
                "SDWebImage/Core": []
            }
        }
    ]
}

Pin It on Pinterest

Share This