Code Monkey home page Code Monkey logo

sdwebimagesvgkitplugin's Introduction

SDWebImageSVGKitPlugin

CI Status Version License Platform Carthage compatible

Background

Currently SDWebImage org provide 3 kinds of SVG Coder Plugin support, here is comparison:

Plugin Name Vector Image Bitmap Image Platform Compatibility Dependency
SVGNativeCoder NO YES iOS 9+ Best and W3C standard adobe/svg-native-viewer
SVGCoder YES YES iOS 13+ OK but buggy on some SVG Apple CoreSVG(Private)
SVGKitPlugin YES NO iOS 9+ Worst, no longer maintain SVGKit/SVGKit

What's for

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

Note: iOS 13+/macOS 10.15+ supports native SVG rendering (called Symbol Image), with system framework to load SVG. Check SDWebImageSVGCoder for more information.

Example

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.

Requirements

  • iOS 9+
  • tvOS 9+
  • macOS 10.11+
  • Xcode 11+

Installation

CocoaPods

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

pod 'SDWebImageSVGKitPlugin'

Swift Package Manager (Xcode 11+)

SDWebImagePhotosPlugin is available through Swift Package Manager.

let package = Package(
    dependencies: [
        .package(url: "https://github.com/SDWebImage/SDWebImageSVGKitPlugin.git", from: "1.4")
    ]
)

Carthage

SDWebImageSVGKitPlugin is available through Carthage.

github "SDWebImage/SDWebImageSVGKitPlugin"

Usage

Use UIImageView (render SVG as bitmap image)

To use SVG coder, you should firstly add the SDImageSVGKCoder 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 SDWebImageContextThumbnailPixelSize context option. And you can specify whether or not to keep aspect ratio during scale using SDWebImageContextImagePreserveAspectRatio context option.

  • Objective-C
SDImageSVGKCoder *svgCoder = [SDImageSVGKCoder 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:@{SDWebImageContextThumbnailPixelSize : @(svgImageSize)];
  • Swift
let svgCoder = SDImageSVGKCoder.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: [.imageThumbnailPixelSize : svgImageSize])

Use SVGKImageView (render SVG as vector image)

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)

Export SVG data

SDWebImageSVGKitPlugin provide an easy way to export the SVG image generated from framework, to the original SVG data.

  • Objective-C
UIImage *image; // Image generated from SDWebImage framework, actually a `SDSVGKImage` instance.
NSData *imageData = [image sd_imageDataAsFormat:SDImageFormatSVG];
  • Swift
let image: UIImage // Image generated from SDWebImage framework, actually a `SDSVGKImage` instance.
let imageData = image.sd_imageData(as: .SVG)

Screenshot

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

Author

DreamPiggy

License

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

sdwebimagesvgkitplugin's People

Contributors

dreampiggy avatar dwaynecoussement avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

sdwebimagesvgkitplugin's Issues

Suggestion: Drop SVGKit support and use SVG-Native standard for mobile system

SVGKit repo seems no longer activelly maintained. And the SVG features support is still lack of support for long time. And there are many many of bugs in implementation.

Across all the open-source world, there are no any SVG library that implements the standard on iOS system, including SwiftSVG, Macaw, etc. I've already try all of them.

Recentlly, there is a new W3C standard called SVG-Native. It's aim to provide a SVG vector format which based on SVG 1.1, without some features which heavily required Web environment, like CSS, Script, x-linking.

I think this is the future of our library to support SVG, a vector format. Since our users always use the Native rendering engine, we're not a WebKit port to render some vector format (So why not using WKWebView?).

If you think this is the correct way to use vector format on mobile system, I'd like to implements with the support library once the SVG-Native 1.0 standard is released.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.