SDWebImageSVGCoder is a SVG coder plugin for SDWebImage framework, which provide the image loading support for SVG using SVGKit SVG engine.

To run the example project, clone the repo, and run pod install from the Example directory first.

You can modify the code or use some other SVG files to check the compatibility.

• iOS 8
• tvOS 9
• macOS 10.10

SDWebImageSVGCoder is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'SDWebImageSVGCoder'

SDWebImageSVGCoder is available through Carthage.

Note that because the dependency SDWebImage currently is in beta. You should use Carthage v0.30.1 or above to support beta sem-version.

github "SDWebImage/SDWebImageSVGCoder" 

To use SVG coder, you should firstly add the SDImageSVGCoder to the coders manager. Then you can call the View Category method to start load SVG images.

Because SVG is a vector image format, which means it does not have a fixed bitmap size. However, UIImage or CGImage are all bitmap image. For UIImageView, we will only parse SVG with a fixed image size (from the SVG viewPort information). But we also support you to specify a desired size during image loading using SVGImageSize context option. And you can specify whether or not to keep aspect ratio during scale using SVGImagePreserveAspectRatio context option.

• Objective-C

SDImageSVGCoder *SVGCoder = [SDImageSVGCoder sharedCoder]; [[SDImageCodersManager sharedManager] addCoder:SVGCoder]; UIImageView *imageView; // this arg is optional, if don't provide, use the viewport size instead CGSize SVGImageSize = CGSizeMake(100, 100); [imageView sd_setImageWithURL:url placeholderImage:nil options:0 context:@{SDWebImageContextSVGImageSize : @(SVGImageSize)];

• Swift

let SVGCoder = SDImageSVGCoder.shared SDImageCodersManager.shared.addCoder(SVGCoder) let imageView: UIImageView imageView.sd_setImage(with: url) // this arg is optional, if don't provide, use the viewport size instead let SVGImageSize = CGSize(width: 100, height: 100) imageView.sd_setImage(with: url, placeholderImage: nil, options: [], context: [.svgImageSize : SVGImageSize])

SVGKit also provide some built-in image view class for vector image loading (scale to any size without losing detail). The SVGKLayeredImageView && SVGKFastImageView are the subclass of SVGKImageView base class. We supports these image view class as well. You can just use the same API like normal UIImageView.

For the documentation about SVGKLayeredImageView, SVGKFastImageView or SVGKImageView, check SVGKit repo for more information.

Note: If you only use these image view class and don't use SVG on UIImageView, you don't need to register the SVG coder to coders manager. These image view loading was using the Custom Image Class feature of SDWebImage.

Attention: These built-in image view class does not works well on UIView.contentMode property, you need to re-scale the layer tree after image was loaded. We provide a simple out-of-box solution to support it. Set the sd_adjustContentMode property to YES then all things done.

• Objective-C

SVGKImageView *imageView; // can be either `SVGKLayeredImageView` or `SVGKFastImageView` imageView.contentMode = UIViewContentModeScaleAspectFill; imageView.sd_adjustContentMode = YES; // make `contentMode` works [imageView sd_setImageWithURL:url];

• Swift:

let imageView: SVGKImageView // can be either `SVGKLayeredImageView` or `SVGKFastImageView` imageView.contentMode = .aspectFill imageView.sd_adjustContentMode = true // make `contentMode` works imageView.sd_setImage(with: url)

These SVG images are from wikimedia, you can try the demo with your own SVG image as well.

DreamPiggy

SDWebImageSVGCoder is available under the MIT license. See the LICENSE file for more info.