|
@@ -1,334 +1,352 @@
|
|
|
-Web Image
|
|
|
-=========
|
|
|
-[](https://travis-ci.org/rs/SDWebImage)
|
|
|
+<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://www.versioneye.com/objective-c/sdwebimage/3.3)
|
|
|
-[](https://www.versioneye.com/objective-c/sdwebimage/references)
|
|
|
-[](https://github.com/rs/SDWebImage)
|
|
|
-
|
|
|
-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
|
|
|
-- Animated GIF support
|
|
|
-- WebP format support
|
|
|
-- 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
|
|
|
-- Arm64 support
|
|
|
-
|
|
|
-NOTE: Version 3.8 of SDWebImage requires iOS 7 or later (because of NSURLSession).
|
|
|
-Versions 3.7 to 3.0 requires iOS 5.1.1. If you need iOS < 5.0 support, please use the last [2.0 version](https://github.com/rs/SDWebImage/tree/2.0-compat).
|
|
|
+[](https://github.com/SDWebImage/SDWebImage)
|
|
|
+[](https://swift.org/package-manager/)
|
|
|
+[](https://developer.apple.com/documentation/xcode/creating_a_mac_version_of_your_ipad_app/)
|
|
|
+[](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 to avoid frame rate drop
|
|
|
+- [x] [Progressive image loading](https://github.com/SDWebImage/SDWebImage/wiki/Advanced-Usage#progressive-animation) (including animated image, like GIF showing in Web browser)
|
|
|
+- [x] [Thumbnail image decoding](https://github.com/SDWebImage/SDWebImage/wiki/Advanced-Usage#thumbnail-decoding-550) to save CPU && Memory for large images
|
|
|
+- [x] [Extendable image coder](https://github.com/SDWebImage/SDWebImage/wiki/Advanced-Usage#custom-coder-420) to support massive image format, like WebP
|
|
|
+- [x] [Full-stack solution for animated images](https://github.com/SDWebImage/SDWebImage/wiki/Advanced-Usage#animated-image-50) which keep a balance between CPU && Memory
|
|
|
+- [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] [Customizable and multiple caches system](https://github.com/SDWebImage/SDWebImage/wiki/Advanced-Usage#custom-cache-50)
|
|
|
+- [x] [Customizable and multiple loaders system](https://github.com/SDWebImage/SDWebImage/wiki/Advanced-Usage#custom-loader-50) to expand the capabilities, like [Photos Library](https://github.com/SDWebImage/SDWebImagePhotosPlugin)
|
|
|
+- [x] [Image loading indicators](https://github.com/SDWebImage/SDWebImage/wiki/How-to-use#use-view-indicator-50)
|
|
|
+- [x] [Image loading transition animation](https://github.com/SDWebImage/SDWebImage/wiki/Advanced-Usage#image-transition-430)
|
|
|
+- [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] Modern Objective-C and better Swift support
|
|
|
+- [x] Performances!
|
|
|
+
|
|
|
+## Supported Image Formats
|
|
|
+
|
|
|
+- Image formats supported by Apple system (JPEG, PNG, TIFF, BMP, ...), including [GIF](https://github.com/SDWebImage/SDWebImage/wiki/Advanced-Usage#gif-coder)/[APNG](https://github.com/SDWebImage/SDWebImage/wiki/Advanced-Usage#apng-coder) animated image
|
|
|
+- HEIC format from iOS 11/macOS 10.13, including animated HEIC from iOS 13/macOS 10.15 via [SDWebImageHEICCoder](https://github.com/SDWebImage/SDWebImage/wiki/Advanced-Usage#heic-coder). For lower firmware, use coder plugin [SDWebImageHEIFCoder](https://github.com/SDWebImage/SDWebImageHEIFCoder)
|
|
|
+- WebP format from iOS 14/macOS 11.0 via [SDWebImageAWebPCoder](https://github.com/SDWebImage/SDWebImage/wiki/Advanced-Usage#awebp-coder). For lower firmware, use coder plugin [SDWebImageWebPCoder](https://github.com/SDWebImage/SDWebImageWebPCoder)
|
|
|
+- Support extendable coder plugins for new image formats like BPG, AVIF. And vector format like PDF, SVG. See all the list in [Image coder plugin List](https://github.com/SDWebImage/SDWebImage/wiki/Coder-Plugin-List)
|
|
|
+
|
|
|
+## Additional modules and Ecosystem
|
|
|
+
|
|
|
+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).
|
|
|
+
|
|
|
+#### SwiftUI
|
|
|
+[SwiftUI](https://developer.apple.com/xcode/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 called [SDWebImageSwiftUI](https://github.com/SDWebImage/SDWebImageSwiftUI), which is built on top of SDWebImage core functions (caching, loading and animation).
|
|
|
+
|
|
|
+The new framework introduce two View structs `WebImage` and `AnimatedImage` 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!
|
|
|
+
|
|
|
+#### Coders for additional image formats
|
|
|
+- [SDWebImageWebPCoder](https://github.com/SDWebImage/SDWebImageWebPCoder) - coder for WebP format. iOS 8+/macOS 10.10+. Based on [libwebp](https://chromium.googlesource.com/webm/libwebp)
|
|
|
+- [SDWebImageHEIFCoder](https://github.com/SDWebImage/SDWebImageHEIFCoder) - coder for HEIF format, iOS 8+/macOS 10.10+ support. Based on [libheif](https://github.com/strukturag/libheif)
|
|
|
+- [SDWebImageBPGCoder](https://github.com/SDWebImage/SDWebImageBPGCoder) - coder for BPG format. Based on [libbpg](https://github.com/mirrorer/libbpg)
|
|
|
+- [SDWebImageFLIFCoder](https://github.com/SDWebImage/SDWebImageFLIFCoder) - coder for FLIF format. Based on [libflif](https://github.com/FLIF-hub/FLIF)
|
|
|
+- [SDWebImageAVIFCoder](https://github.com/SDWebImage/SDWebImageAVIFCoder) - coder for AVIF (AV1-based) format. Based on [libavif](https://github.com/AOMediaCodec/libavif)
|
|
|
+- [SDWebImagePDFCoder](https://github.com/SDWebImage/SDWebImagePDFCoder) - coder for PDF vector format. Using built-in frameworks
|
|
|
+- [SDWebImageSVGCoder](https://github.com/SDWebImage/SDWebImageSVGCoder) - coder for SVG vector format. Using built-in frameworks
|
|
|
+- [SDWebImageLottieCoder](https://github.com/SDWebImage/SDWebImageLottieCoder) - coder for Lottie animation format. Based on [rlottie](https://github.com/Samsung/rlottie)
|
|
|
+- and more from community!
|
|
|
+
|
|
|
+#### Custom Caches
|
|
|
+- [SDWebImageYYPlugin](https://github.com/SDWebImage/SDWebImageYYPlugin) - plugin to support caching images with [YYCache](https://github.com/ibireme/YYCache)
|
|
|
+- [SDWebImagePINPlugin](https://github.com/SDWebImage/SDWebImagePINPlugin) - plugin to support caching images with [PINCache](https://github.com/pinterest/PINCache)
|
|
|
+
|
|
|
+#### Custom Loaders
|
|
|
+- [SDWebImagePhotosPlugin](https://github.com/SDWebImage/SDWebImagePhotosPlugin) - plugin to support loading images from Photos (using `Photos.framework`)
|
|
|
+- [SDWebImageLinkPlugin](https://github.com/SDWebImage/SDWebImageLinkPlugin) - plugin to support loading images from rich link url, as well as `LPLinkView` (using `LinkPresentation.framework`)
|
|
|
+
|
|
|
+#### Integration with 3rd party libraries
|
|
|
+- [SDWebImageLottiePlugin](https://github.com/SDWebImage/SDWebImageLottiePlugin) - plugin to support [Lottie-iOS](https://github.com/airbnb/lottie-ios), vector animation rending with remote JSON files
|
|
|
+- [SDWebImageSVGKitPlugin](https://github.com/SDWebImage/SDWebImageSVGKitPlugin) - plugin to support [SVGKit](https://github.com/SVGKit/SVGKit), SVG rendering using Core Animation, iOS 8+/macOS 10.10+ support
|
|
|
+- [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
|
|
|
+
|
|
|
+#### Community driven popular libraries
|
|
|
+- [FirebaseUI](https://github.com/firebase/FirebaseUI-iOS) - Firebase Storage binding for query images, based on SDWebImage loader system
|
|
|
+- [react-native-fast-image](https://github.com/DylanVann/react-native-fast-image) - React Native fast image component, based on SDWebImage Animated Image solution
|
|
|
+- [flutter_image_compress](https://github.com/OpenFlutter/flutter_image_compress) - Flutter compresses image plugin, based on SDWebImage WebP coder plugin
|
|
|
+
|
|
|
+#### 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.
|
|
|
+- [libavif-Xcode](https://github.com/SDWebImage/libavif-Xcode) - A wrapper for [libavif](https://github.com/AOMediaCodec/libavif) + 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.
|
|
|
+
|
|
|
+## Requirements
|
|
|
+
|
|
|
+- iOS 9.0 or later
|
|
|
+- tvOS 9.0 or later
|
|
|
+- watchOS 2.0 or later
|
|
|
+- macOS 10.11 or later (10.15 for Catalyst)
|
|
|
+- Xcode 11.0 or later
|
|
|
+
|
|
|
+#### Backwards compatibility
|
|
|
+
|
|
|
+- For iOS 8, macOS 10.10 or Xcode < 11, use [any 5.x version up to 5.9.5](https://github.com/SDWebImage/SDWebImage/releases/tag/5.9.5)
|
|
|
+- 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/releases/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://github.com/SDWebImage/SDWebImage/blob/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://github.com/SDWebImage/SDWebImage/blob/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 **need IRC channel**, use [Gitter](https://gitter.im/SDWebImage/community).
|
|
|
|
|
|
-[How is SDWebImage better than X?](https://github.com/rs/SDWebImage/wiki/How-is-SDWebImage-better-than-X%3F)
|
|
|
+## Contribution
|
|
|
|
|
|
-Who Uses It
|
|
|
-----------
|
|
|
+- If you **want to contribute**, read the [Contributing Guide](https://github.com/SDWebImage/SDWebImage/blob/master/.github/CONTRIBUTING.md)
|
|
|
+- For **development contribution guide**, read the [How-To-Contribute](https://github.com/SDWebImage/SDWebImage/wiki/How-to-Contribute)
|
|
|
+- For **understanding code architecture**, read the [Code Architecture Analysis](https://github.com/SDWebImage/SDWebImage/wiki/5.6-Code-Architecture-Analysis)
|
|
|
|
|
|
-Find out [who uses SDWebImage](https://github.com/rs/SDWebImage/wiki/Who-Uses-SDWebImage) and add your app to the list.
|
|
|
+## How To Use
|
|
|
|
|
|
-How To Use
|
|
|
-----------
|
|
|
-
|
|
|
-API documentation is available at [CocoaDocs - SDWebImage](http://cocoadocs.org/docsets/SDWebImage/)
|
|
|
-
|
|
|
-### Using UIImageView+WebCache category with UITableView
|
|
|
-
|
|
|
-Just #import the UIImageView+WebCache.h header, and call the sd_setImageWithURL:placeholderImage:
|
|
|
-method from the tableView:cellForRowAtIndexPath: UITableViewDataSource method. Everything will be
|
|
|
-handled for you, from async downloads to caching management.
|
|
|
+* Objective-C
|
|
|
|
|
|
```objective-c
|
|
|
-#import <SDWebImage/UIImageView+WebCache.h>
|
|
|
-
|
|
|
+#import <SDWebImage/SDWebImage.h>
|
|
|
...
|
|
|
-
|
|
|
-- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath {
|
|
|
- static NSString *MyIdentifier = @"MyIdentifier";
|
|
|
-
|
|
|
- UITableViewCell *cell = [tableView dequeueReusableCellWithIdentifier:MyIdentifier];
|
|
|
- if (cell == nil) {
|
|
|
- cell = [[[UITableViewCell alloc] initWithStyle:UITableViewCellStyleDefault
|
|
|
- reuseIdentifier:MyIdentifier] autorelease];
|
|
|
- }
|
|
|
-
|
|
|
- // Here we use the new provided sd_setImageWithURL: method to load the web image
|
|
|
- [cell.imageView sd_setImageWithURL:[NSURL URLWithString:@"http://www.domain.com/path/to/image.jpg"]
|
|
|
- placeholderImage:[UIImage imageNamed:@"placeholder.png"]];
|
|
|
-
|
|
|
- cell.textLabel.text = @"My Text";
|
|
|
- return cell;
|
|
|
-}
|
|
|
+[imageView sd_setImageWithURL:[NSURL URLWithString:@"http://www.domain.com/path/to/image.jpg"]
|
|
|
+ placeholderImage:[UIImage imageNamed:@"placeholder.png"]];
|
|
|
```
|
|
|
|
|
|
-### Using blocks
|
|
|
+* Swift
|
|
|
|
|
|
-With blocks, you can be notified about the image download progress and whenever the image retrieval
|
|
|
-has completed with success or not:
|
|
|
+```swift
|
|
|
+import SDWebImage
|
|
|
|
|
|
-```objective-c
|
|
|
-// Here we use the new provided sd_setImageWithURL: method to load the web image
|
|
|
-[cell.imageView sd_setImageWithURL:[NSURL URLWithString:@"http://www.domain.com/path/to/image.jpg"]
|
|
|
- placeholderImage:[UIImage imageNamed:@"placeholder.png"]
|
|
|
- completed:^(UIImage *image, NSError *error, SDImageCacheType cacheType, NSURL *imageURL) {
|
|
|
- ... completion code here ...
|
|
|
- }];
|
|
|
+imageView.sd_setImage(with: URL(string: "http://www.domain.com/path/to/image.jpg"), placeholderImage: UIImage(named: "placeholder.png"))
|
|
|
```
|
|
|
|
|
|
-Note: neither your success nor failure block will be call if your image request is canceled before completion.
|
|
|
+- For details about how to use the library and clear examples, see [The detailed How to use](https://github.com/SDWebImage/SDWebImage/blob/master/Docs/HowToUse.md)
|
|
|
|
|
|
-### Using SDWebImageManager
|
|
|
+## Animated Images (GIF) support
|
|
|
|
|
|
-The SDWebImageManager is the class behind the UIImageView+WebCache category. It ties the
|
|
|
-asynchronous downloader with the image cache store. You can use this class directly to benefit
|
|
|
-from web image downloading with caching in another context than a UIView (ie: with Cocoa).
|
|
|
+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).
|
|
|
|
|
|
-Here is a simple example of how to use SDWebImageManager:
|
|
|
+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.
|
|
|
|
|
|
-```objective-c
|
|
|
-SDWebImageManager *manager = [SDWebImageManager sharedManager];
|
|
|
-[manager downloadImageWithURL:imageURL
|
|
|
- options:0
|
|
|
- progress:^(NSInteger receivedSize, NSInteger expectedSize) {
|
|
|
- // progression tracking code
|
|
|
- }
|
|
|
- completed:^(UIImage *image, NSError *error, SDImageCacheType cacheType, BOOL finished, NSURL *imageURL) {
|
|
|
- if (image) {
|
|
|
- // do something with image
|
|
|
- }
|
|
|
- }];
|
|
|
-```
|
|
|
-
|
|
|
-### Using Asynchronous Image Downloader Independently
|
|
|
-
|
|
|
-It's also possible to use the async image downloader independently:
|
|
|
-
|
|
|
-```objective-c
|
|
|
-SDWebImageDownloader *downloader = [SDWebImageDownloader sharedDownloader];
|
|
|
-[downloader downloadImageWithURL:imageURL
|
|
|
- options:0
|
|
|
- progress:^(NSInteger receivedSize, NSInteger expectedSize) {
|
|
|
- // progression tracking code
|
|
|
- }
|
|
|
- completed:^(UIImage *image, NSData *data, NSError *error, BOOL finished) {
|
|
|
- if (image && finished) {
|
|
|
- // do something with image
|
|
|
- }
|
|
|
- }];
|
|
|
-```
|
|
|
+The `SDAnimatedImageView` supports the familiar image loading category methods, works like drop-in replacement for `UIImageView/NSImageView`.
|
|
|
|
|
|
-### Using Asynchronous Image Caching Independently
|
|
|
+Don't have `UIView` (like `WatchKit` or `CALayer`)? you can still use `SDAnimatedPlayer` the player engine for advanced playback and rendering.
|
|
|
|
|
|
-It is also possible to use the async based image cache store independently. SDImageCache
|
|
|
-maintains a memory cache and an optional disk cache. Disk cache write operations are performed
|
|
|
-asynchronous so it doesn't add unnecessary latency to the UI.
|
|
|
+See [Animated Image](https://github.com/SDWebImage/SDWebImage/wiki/Advanced-Usage#animated-image-50) for more detailed information.
|
|
|
|
|
|
-The SDImageCache class provides a singleton instance for convenience but you can create your own
|
|
|
-instance if you want to create separated cache namespace.
|
|
|
-
|
|
|
-To lookup the cache, you use the `queryDiskCacheForKey:done:` method. If the method returns nil, it means the cache
|
|
|
-doesn't currently own the image. You are thus responsible for generating and caching it. The cache
|
|
|
-key is an application unique identifier for the image to cache. It is generally the absolute URL of
|
|
|
-the image.
|
|
|
+* Objective-C
|
|
|
|
|
|
```objective-c
|
|
|
-SDImageCache *imageCache = [[SDImageCache alloc] initWithNamespace:@"myNamespace"];
|
|
|
-[imageCache queryDiskCacheForKey:myCacheKey done:^(UIImage *image) {
|
|
|
- // image is not nil if image was found
|
|
|
-}];
|
|
|
+SDAnimatedImageView *imageView = [SDAnimatedImageView new];
|
|
|
+SDAnimatedImage *animatedImage = [SDAnimatedImage imageNamed:@"image.gif"];
|
|
|
+imageView.image = animatedImage;
|
|
|
```
|
|
|
|
|
|
-By default SDImageCache will lookup the disk cache if an image can't be found in the memory cache.
|
|
|
-You can prevent this from happening by calling the alternative method `imageFromMemoryCacheForKey:`.
|
|
|
-
|
|
|
-To store an image into the cache, you use the storeImage:forKey: method:
|
|
|
+* Swift
|
|
|
|
|
|
-```objective-c
|
|
|
-[[SDImageCache sharedImageCache] storeImage:myImage forKey:myCacheKey];
|
|
|
+```swift
|
|
|
+let imageView = SDAnimatedImageView()
|
|
|
+let animatedImage = SDAnimatedImage(named: "image.gif")
|
|
|
+imageView.image = animatedImage
|
|
|
```
|
|
|
|
|
|
-By default, the image will be stored in memory cache as well as on disk cache (asynchronously). If
|
|
|
-you want only the memory cache, use the alternative method storeImage:forKey:toDisk: with a negative
|
|
|
-third argument.
|
|
|
-
|
|
|
-### Using cache key filter
|
|
|
-
|
|
|
-Sometime, you may not want to use the image URL as cache key because part of the URL is dynamic
|
|
|
-(i.e.: for access control purpose). SDWebImageManager provides a way to set a cache key filter that
|
|
|
-takes the NSURL as input, and output a cache key NSString.
|
|
|
-
|
|
|
-The following example sets a filter in the application delegate that will remove any query-string from
|
|
|
-the URL before to use it as a cache key:
|
|
|
-
|
|
|
-```objective-c
|
|
|
-- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
|
|
|
- SDWebImageManager.sharedManager.cacheKeyFilter = ^(NSURL *url) {
|
|
|
- url = [[NSURL alloc] initWithScheme:url.scheme host:url.host path:url.path];
|
|
|
- return [url absoluteString];
|
|
|
- };
|
|
|
-
|
|
|
- // Your app init code...
|
|
|
- return YES;
|
|
|
-}
|
|
|
-```
|
|
|
-
|
|
|
-
|
|
|
-Common Problems
|
|
|
----------------
|
|
|
+#### 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).
|
|
|
|
|
|
-### Using dynamic image size with UITableViewCell
|
|
|
+## Installation
|
|
|
|
|
|
-UITableView determines the size of the image by the first image set for a cell. If your remote images
|
|
|
-don't have the same size as your placeholder image, you may experience strange anamorphic scaling issue.
|
|
|
-The following article gives a way to workaround this issue:
|
|
|
-
|
|
|
-[http://www.wrichards.com/blog/2011/11/sdwebimage-fixed-width-cell-images/](http://www.wrichards.com/blog/2011/11/sdwebimage-fixed-width-cell-images/)
|
|
|
-
|
|
|
-
|
|
|
-### Handle image refresh
|
|
|
+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)
|
|
|
|
|
|
-SDWebImage does very aggressive caching by default. It ignores all kind of caching control header returned by the HTTP server and cache the returned images with no time restriction. It implies your images URLs are static URLs pointing to images that never change. If the pointed image happen to change, some parts of the URL should change accordingly.
|
|
|
+### Installation with CocoaPods
|
|
|
|
|
|
-If you don't control the image server you're using, you may not be able to change the URL when its content is updated. This is the case for Facebook avatar URLs for instance. In such case, you may use the `SDWebImageRefreshCached` flag. This will slightly degrade the performance but will respect the HTTP caching control headers:
|
|
|
+[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.
|
|
|
|
|
|
-``` objective-c
|
|
|
-[imageView sd_setImageWithURL:[NSURL URLWithString:@"https://graph.facebook.com/olivier.poitrey/picture"]
|
|
|
- placeholderImage:[UIImage imageNamed:@"avatar-placeholder.png"]
|
|
|
- options:SDWebImageRefreshCached];
|
|
|
+#### Podfile
|
|
|
+```
|
|
|
+platform :ios, '8.0'
|
|
|
+pod 'SDWebImage', '~> 5.0'
|
|
|
```
|
|
|
|
|
|
-### Add a progress indicator
|
|
|
-
|
|
|
-See this category: https://github.com/JJSaccolo/UIActivityIndicator-for-SDWebImage
|
|
|
-
|
|
|
-Installation
|
|
|
-------------
|
|
|
-
|
|
|
-There are three ways to use SDWebImage in your project:
|
|
|
-- using CocoaPods
|
|
|
-- copying all the files into your project
|
|
|
-- importing the project as a static library
|
|
|
+##### Swift and static framework
|
|
|
|
|
|
-### Installation with CocoaPods
|
|
|
+Swift project previously had to use `use_frameworks!` to make all Pods into dynamic framework to let CocoaPods work.
|
|
|
|
|
|
-[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.
|
|
|
+However, starting 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!`:
|
|
|
|
|
|
-#### Podfile
|
|
|
```
|
|
|
-platform :ios, '7.0'
|
|
|
-pod 'SDWebImage', '~>3.8'
|
|
|
+platform :ios, '8.0'
|
|
|
+# Uncomment the next line when you want all Pods as static framework
|
|
|
+# use_modular_headers!
|
|
|
+pod 'SDWebImage', :modular_headers => true
|
|
|
```
|
|
|
|
|
|
-If you are using Swift, be sure to add `use_frameworks!` and set your target to iOS 8+:
|
|
|
+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 3 subspecs available now: `Core`, `MapKit` 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).
|
|
|
+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/WebP'
|
|
|
+pod 'SDWebImage/MapKit'
|
|
|
```
|
|
|
|
|
|
-### Installation with Carthage (iOS 8+)
|
|
|
+### Installation with Carthage
|
|
|
|
|
|
[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)
|
|
|
|
|
|
-#### Cartfile
|
|
|
-```
|
|
|
-github "rs/SDWebImage"
|
|
|
-```
|
|
|
+Carthage users can point to this repository and use whichever generated framework they'd like: SDWebImage, SDWebImageMapKit or both.
|
|
|
|
|
|
-#### Usage
|
|
|
-Swift
|
|
|
+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).
|
|
|
|
|
|
-If you installed using CocoaPods:
|
|
|
-```
|
|
|
-import SDWebImage
|
|
|
-```
|
|
|
+> 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.
|
|
|
|
|
|
-If you installed manually:
|
|
|
-```
|
|
|
-import WebImage
|
|
|
-```
|
|
|
+### Installation with Swift Package Manager (Xcode 11+)
|
|
|
|
|
|
-Objective-C
|
|
|
+[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")
|
|
|
+ ],
|
|
|
+ // ...
|
|
|
+)
|
|
|
```
|
|
|
-@import WebImage;
|
|
|
-```
|
|
|
|
|
|
-### Installation by cloning the repository
|
|
|
+### 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:
|
|
|
|
|
|
-In order to gain access to all the files from the repository, you should clone it.
|
|
|
+```objective-c
|
|
|
+#import <SDWebImage/SDWebImage.h>
|
|
|
```
|
|
|
-git clone --recursive https://github.com/rs/SDWebImage.git
|
|
|
+
|
|
|
+It's also recommend to use the module import syntax, available for CocoaPods(enable `modular_headers`)/Carthage/SwiftPM.
|
|
|
+
|
|
|
+```objecitivec
|
|
|
+@import SDWebImage;
|
|
|
```
|
|
|
|
|
|
-### Add the SDWebImage project to your project
|
|
|
+### Build Project
|
|
|
|
|
|
-- Download and unzip the last version of the framework from the [download page](https://github.com/rs/SDWebImage/releases)
|
|
|
-- Right-click on the project navigator and select "Add Files to "Your Project":
|
|
|
-- In the dialog, select SDWebImage.framework:
|
|
|
-- Check the "Copy items into destination group's folder (if needed)" checkbox
|
|
|
+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.
|
|
|
|
|
|
-### Add dependencies
|
|
|
+## Data Collection Practices
|
|
|
+As required by the [App privacy details on the App Store](https://developer.apple.com/app-store/app-privacy-details/), here's SDWebImage's list of [Data Collection Practices](https://sdwebimage.github.io/DataCollection/index.html).
|
|
|
|
|
|
-- In you application project app’s target settings, find the "Build Phases" section and open the "Link Binary With Libraries" block:
|
|
|
-- Click the "+" button again and select the "ImageIO.framework", this is needed by the progressive download feature:
|
|
|
+## Author
|
|
|
+- [Olivier Poitrey](https://github.com/rs)
|
|
|
|
|
|
-### Add Linker Flag
|
|
|
+## 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)
|
|
|
|
|
|
-Open the "Build Settings" tab, in the "Linking" section, locate the "Other Linker Flags" setting and add the "-ObjC" flag:
|
|
|
+## Credits
|
|
|
|
|
|
-
|
|
|
+Thank you to all the people who have already contributed to SDWebImage.
|
|
|
|
|
|
-Alternatively, if this causes compilation problems with frameworks that extend optional libraries, such as Parse, RestKit or opencv2, instead of the -ObjC flag use:
|
|
|
-```
|
|
|
--force_load SDWebImage.framework/Versions/Current/SDWebImage
|
|
|
-```
|
|
|
+[](https://github.com/SDWebImage/SDWebImage/graphs/contributors)
|
|
|
|
|
|
-If you're using Cocoa Pods and have any frameworks that extend optional libraries, such as Parsen RestKit or opencv2, instead of the -ObjC flag use:
|
|
|
-```
|
|
|
--force_load $(TARGET_BUILD_DIR)/libPods.a
|
|
|
-```
|
|
|
-and this:
|
|
|
-```
|
|
|
-$(inherited)
|
|
|
-```
|
|
|
+## Licenses
|
|
|
|
|
|
-### Import headers in your source files
|
|
|
+All source code is licensed under the [MIT License](https://github.com/SDWebImage/SDWebImage/blob/master/LICENSE).
|
|
|
|
|
|
-In the source files where you need to use the library, import the header file:
|
|
|
+## Architecture
|
|
|
|
|
|
-```objective-c
|
|
|
-#import <SDWebImage/UIImageView+WebCache.h>
|
|
|
-```
|
|
|
+To learn about SDWebImage's architecture design for contribution, read [The Core of SDWebImage v5.6 Architecture](https://github.com/SDWebImage/SDWebImage/wiki/5.6-Code-Architecture-Analysis). Thanks @looseyi for the post and translation.
|
|
|
|
|
|
-### Build Project
|
|
|
+#### 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>
|
|
|
|
|
|
-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.
|
|
|
+#### 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>
|
|
|
|
|
|
-Future Enhancements
|
|
|
--------------------
|
|
|
+#### 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>
|
|
|
|
|
|
-- LRU memory cache cleanup instead of reset on memory warning
|
|
|
+#### Main Sequence Diagram
|
|
|
+<p align="center" >
|
|
|
+ <img src="https://raw.githubusercontent.com/SDWebImage/SDWebImage/master/Docs/Diagrams/SDWebImageSequenceDiagram.png" title="SDWebImage sequence diagram">
|
|
|
+</p>
|
|
|
|
|
|
-## Licenses
|
|
|
+#### 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)
|
|
|
|
|
|
-All source code is licensed under the [MIT License](https://raw.github.com/rs/SDWebImage/master/LICENSE).
|