Skip to content
Display and interact with SVG Images on iOS / OS X, using native rendering (CoreAnimation)
Objective-C HTML C Other
Branch: 3.x
Clone or download
hao7664 and adamgit Fix warnings of `GCC_WARN_ABOUT_MISSING_NEWLINE` for 3.x branch (#608)
* Fix warnings of `GCC_WARN_ABOUT_MISSING_NEWLINE`

* Turn on `GCC_WARN_ABOUT_MISSING_NEWLINE` in Xcode project

* Revert "Turn on `GCC_WARN_ABOUT_MISSING_NEWLINE` in Xcode project"

This reverts commit 875aef1.
Latest commit 39dd210 Sep 10, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
3rd-party-frameworks/CocoaLumberjack-2.2.0
Demo-OSX.xcodeproj Use NSScanner to tokenize class names instead of -[NSString enumerate… Nov 2, 2018
Demo-Samples
Demo-iOS.xcodeproj Update the SVGKit static library (iOS only) version to 2.1.0 Oct 29, 2018
SVGKit-iOS.xcodeproj Remove target-level disabling of asserts in release Configuration, ad… Feb 27, 2019
SVGKitFrameworks Upgrade the framework version to 2.1.0 Oct 29, 2018
SVGKitLibrary Add custom module map for CocoaPods user, which avoid automatically g… Oct 27, 2018
Source Fix warnings of `GCC_WARN_ABOUT_MISSING_NEWLINE` for 3.x branch (#608) Sep 10, 2019
.gitignore Add Carthage support. Clarity the framework_search_path Oct 12, 2018
.travis.yml Add Travis CI support, build all the scheme (iOS/tvOS/macOS) and iOS/… Oct 27, 2018
CONTRIBUTING.md Update CONTRIBUTING.md Feb 15, 2017
Cartfile Add Carthage support. Clarity the framework_search_path Oct 12, 2018
Cartfile.resolved Add Carthage support. Clarity the framework_search_path Oct 12, 2018
ISSUE_TEMPLATE Create ISSUE_TEMPLATE Feb 15, 2017
LICENSE Fixed some obscure crashing bugs in parser. Updated the Demo app to b… Apr 1, 2015
README.mdown
SVGKit.podspec

README.mdown

SVGKit

SVGKit is a Cocoa framework for rendering SVG files natively: it's fast and powerful. Some additional info and links are on the wiki

Versions:

Latest info at: https://github.com/SVGKit/SVGKit/wiki/Versions

  • v3.x = current "in development" branch with latest changes, fixes, features
    • NB: this is now automatically selected in GitHub as the "default" branch when you visit SVGKit's project page

Getting Started

Run the Demo - iOS

  1. Open up "Demo-iOS.xcodeproj", and run it (on simulator or device). Try different SVG's. Zoom, pan, and (with the Monkey only:) hit the "Animate" button. Tap the images to see bounding-boxes / hit dectection (might need you to hit the Debug button first)
  2. If you have ANY problems building the library and embedding it in your app, compare your build settings to the Demo-iOS build settings - if something's different, it's probably the problem.

Installation (add SVGKit to your app)

You have 3 main options for installing SVGKit:

  1. Drag/drop the .framework file into your project <-- PREFERRED / RECOMMENDED
  2. Use CocoaPods
  3. Use Carthage
  4. Drag/drop the static library into your project, and configure the build settings in your project

NB: the "static library" is our backwards-compatible, manual install that always works if you have problems with CocoaPods/Carthage/Framework.

OPTION 1: Use the Framework - drag, drop, done!

  1. Open "SVGKit-iOS.xcodeproj"
  2. Build the project once
  3. In Project Navigator, expand the Products folder
  4. Drag/drop SVGKit.framework into your app-project

NB: Frameworks are the preferred way to use libraries in Xcode. But this is a new feature, it might have bugs. If you have ANY problems, please create an Issue, but also try the Static Library method below

You MAY also need to manually add the following Apple Frameworks to your app:

  • CoreText
  • CoreImage
  • libxml2.dylib
  • QuartzCore
  • CoreGraphics
  • UIKit

You MAY also need to add the following 3rd party Frameworks to your app (included with SVGKit):

  • CocoaLumberjack (in the SVGKit-iOS project, select the "3rd-party-frameworks" folder, and drag/drop whichever versions you need: iOS, tvOS, etc) Remember to embed the library too (should show under Target -> General -> Embedded Binaries)

OPTION 2: Using CocoaPods

CocoaPods is a dependency manager for CocoaTouch. To do CocoaPods, adding the following in your podfile:

pod 'SVGKit'

It is also recommended that you setup your podfile to get SVGKit from the latest branch (October 2018: currently 3.x).

pod 'SVGKit', :git => 'https://github.com/SVGKit/SVGKit.git', :branch => '3.x'

OPTION 3: Using Carthage

Carthage is a decentralized dependency manager for Cocoa. To use Carthage, adding the following in your Cartfile:

github "SVGKit/SVGKit"

It is also recommended that you setup your Cartfile to get SVGKit from the current version (October 2018: 3.x branch).

github "SVGKit/SVGKit" "3.x"

OPTION 4: Build the static library

We have a build script that automatically builds ALL versions of the library at once, and ships them as a single file: http://stackoverflow.com/questions/3520977/build-fat-static-library-device-simulator-using-xcode-and-sdk-4/3647187#3647187

It's all setup already, all you need to do is:

  1. Open "SVGKit-iOS.xcodeproj", switch to "SVGKit-iOS" target and Build it (cmd-B)
  2. in left navbar, scroll to bottom, and open the "Products" section
  3. right click the library ("libSVGKitBLAHBLAH.a") and select "show in finder"
  4. GO UP ONE FOLDER
  5. select the "Debug-universal" (or Release-universal if you were building in Release mode) folder
  6. Drag/drop the .a file and the "usr" folder into your project (select the "Copy files" checkbox)
  7. In Build Settings, select "Other Linker Flags" and add "-ObjC"
  8. Edit your build settings and set "C/C++ Compiler Version" = "LLVM Compiler 2.0"
  9. Add ALL the frameworks and 3rd party libraries listed below (go to "Build Phases", and "Link Binary with Libraries"):
  • CoreText
  • CoreImage
  • libxml2.dylib
  • QuartzCore
  • CoreGraphics
  • UIKit

Everything else is automatic.

Usage - OS X

Added in version 2.1.0 / Autumn 2018: support for macOS.

You can use nearly the same API like iOS. Including SVGKFastImageView, SVGKLayeredImageView, and you can use SVGKImage.NSImage to export SVG layer to bitmap image.

We also provide a macOS demo for SVGKit. To run the Demo, open Demo-OSX.xcodeproj and built to run. You can browser the different SVG files using those two different type of view to check the compatibility.

Recipes for using the library

Here are some old posts (some of these APIs have changed slightly since they were written) on using SVGKit, with advice on which methods to use and why:

You can’t perform that action at this time.