README.md

    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

    • Categories for UIImageView, 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
    • 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
    • Performances!
    • Use GCD and ARC

    Supported Image Formats

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

    Beta version

    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.

    Requirements

    • 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

    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, submit a pull request.

    How To Use

    • Objective-C
    #import <SDWebImage/UIImageView+WebCache.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

    • 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 FLAnimatedImageView instead of UIImageView.
    • 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 NSImageView with animates set to YES to show the entire animated images and NO to only show the 1st frame. For all the other platforms (tvOS, watchOS) we will fallback to the backwards compatibility feature described above

    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, '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 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 4 subspecs available now: Core, MapKit, GIF and 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).

    Podfile example:

    pod 'SDWebImage/WebP'

    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

    Cartfile

    github "SDWebImage/SDWebImage"

    Installation by cloning the repository

    Import headers in your source files

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

    #import <SDWebImage/UIImageView+WebCache.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

    项目简介

    Asynchronous image downloader with cache support as a UIImageView category

    🚀 Github 镜像仓库 🚀

    源项目地址

    https://github.com/SDWebImage/SDWebImage

    发行版本 104

    5.12.2 - 5.12 Patch

    全部发行版

    贡献者 269

    全部贡献者

    开发语言

    • Objective-C 96.9 %
    • C 2.6 %
    • Ruby 0.3 %
    • Swift 0.1 %