Skip to content
Asynchronous image downloader with cache support as a UIImageView category
Objective-C C Other
Branch: master
Clone or download
dreampiggy Merge pull request #2847 from dreampiggy/bugfix_mac_gif_loop_count
Fix the macOS SDAnimatedImageRep to match Netscape standard of GIF loop count, which should use 1 when there are no loop count information
Latest commit 20c8adc Sep 21, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Change the stale date for issues from 30 days to 60 days Sep 4, 2019
Configs Update the xcconfig of UIKit for macOS config Aug 12, 2019
Docs Delete prepare shell when archive static library and update manual in… Apr 10, 2019
Examples Update the Example for Appkit using the aligning and scaling layout Aug 31, 2019
SDWebImage.xcodeproj Fix the public API configuration of CI build for framework target Sep 20, 2019
SDWebImage.xcworkspace Remove `SDWebImage.xcodeproj` from the workspace, try to solve the Xc… Aug 13, 2019
SDWebImage Fix the macOS SDAnimatedImageRep to match Netscape standard of GIF lo… Sep 20, 2019
Tests Fix the unused code warning on test cases Sep 20, 2019
WebImage Refactory current GIF/APNG coder, use abstract base class `SDImageIOA… Sep 20, 2019
.gitattributes Added 1st version of design (StarUML) May 8, 2016
.gitignore Add the SwiftPM build steps in travis-CI Jun 18, 2019
.travis.yml Change the Travis-CI env to Xcode 10.3 Aug 15, 2019
CHANGELOG.md update CHANGELOG Sep 4, 2019
LICENSE Bumped Copyright to cover 2018 Jul 17, 2018
Package.swift Fix SwiftPM build issue, by moving all the Core source files && heade… Jul 25, 2019
Podfile Update CI to use Xcode 10.2. Combine both the Example and Test Podfil… Jun 18, 2019
README.md update the readme about the manual install Jul 29, 2019
SDWebImage.podspec Merge branch 'master' of https://github.com/dreampiggy/SDWebImage; br… Sep 4, 2019
SDWebImage_logo.png Updated logos per #2579 Mar 19, 2019
SDWebImage_logo_small.png Updated the organization (small) logo - needed a squared one Apr 13, 2019
codecov.yml Config both iOS && macOS flag for codecov report Apr 4, 2019

README.md

Build Status Pod Version Pod Platform Pod License Carthage compatible SwiftPM 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

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 10.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 four ways to use SDWebImage in your project:

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

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 with Swift Package Manager (Xcode 11+)

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 File -> Swift Packages -> Add Package Dependency, enter SDWebImage repo's URL. Or you can login Xcode with your GitHub account and just type SDWebImage 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 your Package.swift file:

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

Manual Installation Guide

See more on Manual install Guide

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

You can’t perform that action at this time.