276 lines
15 KiB
Markdown
276 lines
15 KiB
Markdown
<p align="center" >
|
|
<img src="https://raw.githubusercontent.com/SDWebImage/SDWebImage/master/SDWebImage_logo.png" title="SDWebImage logo" float=left>
|
|
</p>
|
|
|
|
|
|
[](https://travis-ci.org/SDWebImage/SDWebImage)
|
|
[](http://cocoadocs.org/docsets/SDWebImage/)
|
|
[](http://cocoadocs.org/docsets/SDWebImage/)
|
|
[](https://www.apache.org/licenses/LICENSE-2.0.html)
|
|
[](https://github.com/SDWebImage/SDWebImage)
|
|
[](https://swift.org/package-manager/)
|
|
[](https://codecov.io/gh/SDWebImage/SDWebImage)
|
|
|
|
This library provides an async image downloader with cache support. For convenience, we added categories for UI elements like `UIImageView`, `UIButton`, `MKAnnotationView`.
|
|
|
|
## Features
|
|
|
|
- [x] Categories for `UIImageView`, `UIButton`, `MKAnnotationView` adding web image and cache management
|
|
- [x] An asynchronous image downloader
|
|
- [x] An asynchronous memory + disk image caching with automatic cache expiration handling
|
|
- [x] A background image decompression
|
|
- [x] Improved [support for animated images](https://github.com/SDWebImage/SDWebImage/wiki/Advanced-Usage#animated-image-50)
|
|
- [x] [Customizable and composable transformations](https://github.com/SDWebImage/SDWebImage/wiki/Advanced-Usage#transformer-50) can be applied to the images right after download
|
|
- [x] [Custom cache control](https://github.com/SDWebImage/SDWebImage/wiki/Advanced-Usage#custom-cache-50)
|
|
- [x] Expand the image loading capabilites by adding your [own custom loaders](https://github.com/SDWebImage/SDWebImage/wiki/Advanced-Usage#custom-loader-50) or using prebuilt loaders like [FLAnimatedImage plugin](https://github.com/SDWebImage/SDWebImageFLPlugin) or [Photos Library plugin](https://github.com/SDWebImage/SDWebImagePhotosPlugin)
|
|
- [x] [Loading indicators](https://github.com/SDWebImage/SDWebImage/wiki/How-to-use#use-view-indicator-50)
|
|
- [x] A guarantee that the same URL won't be downloaded several times
|
|
- [x] A guarantee that bogus URLs won't be retried again and again
|
|
- [x] A guarantee that main thread will never be blocked
|
|
- [x] Performances!
|
|
- [x] Use GCD and ARC
|
|
|
|
## Supported Image Formats
|
|
|
|
- Image formats supported by UIImage (JPEG, PNG, ...), including GIF
|
|
- WebP format, including animated WebP (use the [SDWebImageWebPCoder](https://github.com/SDWebImage/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](https://github.com/SDWebImage/SDWebImage/wiki/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](https://github.com/SDWebImage).
|
|
|
|
#### Coders for additional image formats
|
|
- [SDWebImageWebPCoder](https://github.com/SDWebImage/SDWebImageWebPCoder) - coder for WebP image format. Based on [libwebp](https://chromium.googlesource.com/webm/libwebp)
|
|
- [SDWebImageHEIFCoder](https://github.com/SDWebImage/SDWebImageHEIFCoder) - coder to support HEIF image without Apple's `Image/IO framework`, iOS 8+/macOS 10.10+ support.
|
|
- [SDWebImageBPGCoder](https://github.com/SDWebImage/SDWebImageBPGCoder) - coder for BPG format
|
|
- [SDWebImageFLIFCoder](https://github.com/SDWebImage/SDWebImageFLIFCoder) - coder for FLIF format
|
|
- and more from community!
|
|
|
|
#### Loaders
|
|
- [SDWebImagePhotosPlugin](https://github.com/SDWebImage/SDWebImagePhotosPlugin) - plugin to support loading images from Photos (using `Photos.framework`)
|
|
|
|
#### Integration with 3rd party libraries
|
|
- [SDWebImageFLPlugin](https://github.com/SDWebImage/SDWebImageFLPlugin) - plugin to support [FLAnimatedImage](https://github.com/Flipboard/FLAnimatedImage) as the engine for animated GIFs
|
|
- [SDWebImageYYPlugin](https://github.com/SDWebImage/SDWebImageYYPlugin) - plugin to integrate [YYImage](https://github.com/ibireme/YYImage) & [YYCache](https://github.com/ibireme/YYCache) for image rendering & caching
|
|
- [SDWebImageProgressiveJPEGDemo](https://github.com/SDWebImage/SDWebImageProgressiveJPEGDemo) - demo project for using `SDWebImage` + [Concorde library](https://github.com/contentful-labs/Concorde) for Progressive JPEG decoding
|
|
|
|
#### Make our lives easier
|
|
- [libwebp-Xcode](https://github.com/SDWebImage/libwebp-Xcode) - A wrapper for [libwebp](https://chromium.googlesource.com/webm/libwebp) + an Xcode project.
|
|
- [libheif-Xcode](https://github.com/SDWebImage/libheif-Xcode) - A wrapper for [libheif](https://github.com/strukturag/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 10.0 or later
|
|
|
|
#### Backwards compatibility
|
|
|
|
- For iOS 7, macOS 10.9 or Xcode < 8, use [any 4.x version up to 4.4.6](https://github.com/SDWebImage/SDWebImage/releases/tag/4.4.6)
|
|
- For macOS 10.8, use [any 4.x version up to 4.3.0](https://github.com/SDWebImage/SDWebImage/releases/tag/4.3.0)
|
|
- For iOS 5 and 6, use [any 3.x version up to 3.7.6](https://github.com/SDWebImage/SDWebImage/tag/3.7.6)
|
|
- For iOS < 5.0, please use the last [2.0 version](https://github.com/SDWebImage/SDWebImage/tree/2.0-compat).
|
|
|
|
## Getting Started
|
|
|
|
- Read this Readme doc
|
|
- Read the [How to use section](https://github.com/SDWebImage/SDWebImage#how-to-use)
|
|
- Read the [Latest Documentation](https://sdwebimage.github.io/) and [CocoaDocs for old version](http://cocoadocs.org/docsets/SDWebImage/)
|
|
- Try the example by downloading the project from Github or even easier using CocoaPods try `pod try SDWebImage`
|
|
- Read the [Installation Guide](https://github.com/SDWebImage/SDWebImage/wiki/Installation-Guide)
|
|
- Read the [SDWebImage 5.0 Migration Guide](https://raw.githubusercontent.com/SDWebImage/SDWebImage/master/Docs/SDWebImage-5.0-Migration-guide.md) to get an idea of the changes from 4.x to 5.x
|
|
- Read the [SDWebImage 4.0 Migration Guide](https://raw.githubusercontent.com/SDWebImage/SDWebImage/master/Docs/SDWebImage-4.0-Migration-guide.md) to get an idea of the changes from 3.x to 4.x
|
|
- Read the [Common Problems](https://github.com/SDWebImage/SDWebImage/wiki/Common-Problems) to find the solution for common problems
|
|
- Go to the [Wiki Page](https://github.com/SDWebImage/SDWebImage/wiki) for more information such as [Advanced Usage](https://github.com/SDWebImage/SDWebImage/wiki/Advanced-Usage)
|
|
|
|
## Who Uses It
|
|
- Find out [who uses SDWebImage](https://github.com/SDWebImage/SDWebImage/wiki/Who-Uses-SDWebImage) and add your app to the list.
|
|
|
|
## Communication
|
|
|
|
- If you **need help**, use [Stack Overflow](http://stackoverflow.com/questions/tagged/sdwebimage). (Tag 'sdwebimage')
|
|
- If you'd like to **ask a general question**, use [Stack Overflow](http://stackoverflow.com/questions/tagged/sdwebimage).
|
|
- 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](https://raw.githubusercontent.com/SDWebImage/SDWebImage/master/.github/CONTRIBUTING.md)
|
|
|
|
## How To Use
|
|
|
|
* Objective-C
|
|
|
|
```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
|
|
|
|
```swift
|
|
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](https://raw.githubusercontent.com/SDWebImage/SDWebImage/master/Docs/HowToUse.md)
|
|
|
|
## 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](https://github.com/SDWebImage/SDWebImage/wiki/Advanced-Usage#animated-image-50) 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](https://github.com/SDWebImage/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](http://cocoapods.org/) 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](http://cocoapods.org/#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](http://blog.cocoapods.org/CocoaPods-1.5.0/)
|
|
|
|
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](https://github.com/Carthage/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](https://github.com/Carthage/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](https://github.com/Carthage/Carthage#adding-frameworks-to-an-application).
|
|
|
|
> 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](https://swift.org/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](https://github.com/SDWebImage/SDWebImage.git). 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:
|
|
|
|
```swift
|
|
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](https://github.com/SDWebImage/SDWebImage/wiki/Installation-Guide#manual-installation-guide)
|
|
|
|
### Import headers in your source files
|
|
|
|
In the source files where you need to use the library, import the umbrella header file:
|
|
|
|
```objective-c
|
|
#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
|
|
- [Olivier Poitrey](https://github.com/rs)
|
|
|
|
## Collaborators
|
|
- [Konstantinos K.](https://github.com/mythodeia)
|
|
- [Bogdan Poplauschi](https://github.com/bpoplauschi)
|
|
- [Chester Liu](https://github.com/skyline75489)
|
|
- [DreamPiggy](https://github.com/dreampiggy)
|
|
- [Wu Zhong](https://github.com/zhongwuzw)
|
|
|
|
## Licenses
|
|
|
|
All source code is licensed under the [MIT License](https://raw.github.com/SDWebImage/SDWebImage/master/LICENSE).
|
|
|
|
## Architecture
|
|
|
|
#### High Level Diagram
|
|
<p align="center" >
|
|
<img src="https://raw.githubusercontent.com/SDWebImage/SDWebImage/master/Docs/Diagrams/SDWebImageHighLevelDiagram.jpeg" title="SDWebImage high level diagram">
|
|
</p>
|
|
|
|
#### Overall Class Diagram
|
|
<p align="center" >
|
|
<img src="https://raw.githubusercontent.com/SDWebImage/SDWebImage/master/Docs/Diagrams/SDWebImageClassDiagram.png" title="SDWebImage overall class diagram">
|
|
</p>
|
|
|
|
#### Top Level API Diagram
|
|
<p align="center" >
|
|
<img src="https://raw.githubusercontent.com/SDWebImage/SDWebImage/master/Docs/Diagrams/SDWebImageTopLevelClassDiagram.png" title="SDWebImage top level API diagram">
|
|
</p>
|
|
|
|
#### Main Sequence Diagram
|
|
<p align="center" >
|
|
<img src="https://raw.githubusercontent.com/SDWebImage/SDWebImage/master/Docs/Diagrams/SDWebImageSequenceDiagram.png" title="SDWebImage sequence diagram">
|
|
</p>
|
|
|
|
#### More detailed diagrams
|
|
- [Manager API Diagram](https://raw.githubusercontent.com/SDWebImage/SDWebImage/master/Docs/Diagrams/SDWebImageManagerClassDiagram.png)
|
|
- [Coders API Diagram](https://raw.githubusercontent.com/SDWebImage/SDWebImage/master/Docs/Diagrams/SDWebImageCodersClassDiagram.png)
|
|
- [Loader API Diagram](https://raw.githubusercontent.com/SDWebImage/SDWebImage/master/Docs/Diagrams/SDWebImageLoaderClassDiagram.png)
|
|
- [Cache API Diagram](https://raw.githubusercontent.com/SDWebImage/SDWebImage/master/Docs/Diagrams/SDWebImageCacheClassDiagram.png)
|