YBImageBrowser Documentation

SDWebImage is an asynchronous image downloader with built-in cache support. It provides categories for common UI elements like UIImageView, UIButton, and MKAnnotationView to simplify web image loading and cache management.

Key features include:

• Asynchronous memory and disk caching with automatic expiration.
• Background image decompression to prevent main thread blocking.
• Support for animated images (GIF, etc.).
• Customizable and composable transformations applied post-download.
• Loading indicators.
• Guarantees against redundant downloads for the same URL and retrying bogus URLs.

SDWebImage supports standard formats via UIImage (JPEG, PNG, etc.) and can be extended for others using coder plugins:

• Standard: JPEG, PNG, and GIF.
• WebP: Supported via the SDWebImageWebPCoder module (includes animated WebP).
• Extensible: Supports APNG, BPG, HFIF, SVG, etc., through additional coder plugins.

SDWebImage supports Swift Package Manager (SwiftPM) from version 5.1.0.

For Xcode users:

1. Go to File -> Swift Packages -> Add Package Dependency.
2. Enter the repository URL: https://github.com/SDWebImage/SDWebImage.git.
3. Select your dependency type (tagged version, branch, or commit).

For framework authors (Package.swift): Add the dependency to 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")
    ],
    // ...
)

To install YYImage manually:

1. Download all files in the YYImage subdirectory.
2. Add the source files to your Xcode project.
3. Link the following required frameworks:
   • UIKit
   • CoreFoundation
   • QuartzCore
   • AssetsLibrary
   • ImageIO
   • Accelerate
   • MobileCoreServices
   • libz
4. Import YYImage.h.

Note on WebP support: If you need WebP support, add Vendor/WebP.framework (static library) to your Xcode project.

To install manually:

1. Download the YBImageBrowser folder and drag it into your project. If you need video support, also download and include the Video folder.
2. Link the following frameworks: SDWebImage and YYImage.
3. Import the headers:
   • Core: YBImageBrowser.h
   • Video: YBIBVideoData.h
4. For WebP support, ensure you have the WebP support files from the YYImage repository.

To install YYImage using Carthage:

1. Add github "ibireme/YYImage" to your Cartfile.
2. Run carthage update --platform ios.
3. Add the generated framework to your Xcode project.
4. Import <YYImage/YYImage.h>.

Note on WebP support: The Carthage framework does not include the WebP component. To support WebP, use CocoaPods or install the WebP component manually.

Add SDWebImage to your Podfile to manage it via CocoaPods. You can install the default Core module or specific subspecs like MapKit.

To use SDWebImage as a static framework (recommended for Swift projects to avoid use_frameworks!), use modular headers:

platform :ios, '8.0'
# Use modular headers for static framework support
use_modular_headers!
pod 'SDWebImage', :modular_headers => true

To use it as a dynamic framework, use use_frameworks!:

platform :ios, '8.0'
use_frameworks!
pod 'SDWebImage'

To install specific subspecs (e.g., MapKit):

pod 'SDWebImage/MapKit'

platform :ios, '8.0'
# Uncomment the next line when you want all Pods as static framework
# use_modular_headers!
pod 'SDWebImage', :modular_headers => true

To install YYImage using CocoaPods:

1. Update CocoaPods to the latest version.
2. Add pod 'YYImage' to your Podfile.
3. Run pod install or pod update.
4. Import <YYImage/YYImage.h> in your source files.

Note on WebP support: The default pod does not include WebP support. To enable it, add pod 'YYImage/WebP' to your Podfile instead.

Add the following entry to your Cartfile to use Carthage as your dependency manager:

gitub "SDWebImage/SDWebImage"

Then run carthage update.

Note: Carthage builds all components (including SDWebImageMapKit). If you do not need MapKit, you can manually delete the SDWebImageMapKit framework from the Carthage Build directory after the update completes.

github "SDWebImage/SDWebImage"

WebP not displaying

• Ensure WebP.framework is added to your project.
• Verify installation by calling YYImageWebPAvailable().

APNG not playing

• Disable Compress PNG Files and Remove Text Metadata From PNG Files in your Xcode Build Settings.
• Alternatively, rename the file extension to .apng.