目录
- .githubUpdate issue.md5年前
- SwiftSVG.xcodeprojAdded debug flag5年前
- SwiftSVG.xcworkspaceReversed checking for interface builder assets6年前
- SwiftSVGAdded nodoc annotations5年前
- SwiftSVGExamplesOrganized test SVGs5年前
- SwiftSVGFrameworkSingle frameworks for all platforms7年前
- SwiftSVGTestsMerge branch 'master' of github.com:mchoe/SwiftSVG into fix/151-deprecate-uppercase-parameter-names5年前
- docsAdded nodoc annotations5年前
- imagesImage Resize7年前
- svgsMore complete documentation7年前
- .gitignoreAdded Package manifest file5年前
- .jazzy.yamlAdded more documentation, tests, and some cleanup7年前
- LICENSEAdded README10年前
- Package.swiftAdded Package manifest file5年前
- README.mdMerge branch 'master' of github.com:mchoe/SwiftSVG into enhancement/swift-5-support6年前
- SwiftSVG.podspecAdded missing css color json file in podspec5年前
邀请码
Key Features
Who Should Use SwiftSVG
SwiftSVG is not meant to be a a full SVG parser. The library supports the most common use cases of flat, solid color SVG elements. It supports grouping and transformations and can parse all path and shape elements.
The best use case for SwiftSVG is for flat icons that you may want to theme at runtime and have good control over. Think icons for your app, especially if you offer light and dark themes. The library can handle complex paths, and more importantly can handle them quickly, so you can use it to display many SVGs, just not every single use case. See the complex example in the examples app.
At this time, gradients are not supported, but this is high on the list of features to support next. Furthermore, text is not supported at this time, but shouldn’t be too difficult to support. Animations are the last major category that isn’t supported, and they probably won’t be in the near future seeing Cocoa already provides rich support.
Finally, if you’re looking to extend this project, that’s another good reason to use SwiftSVG. A lot of work has been put into making the code as extensible and maintainable as possible and will continue to be a core feature of future updates. Fork the project and I hope you share your changes.
Table of Contents
Install
Cocoapods:
or Carthage:
For projects currently using 1.x: SwiftSVG 2.x is a major rewrite of the library. For most use cases, you should be able to upgrade to 2.0 with little to no changes to your code. However, there are breaking changes that may affect your project. Most notably, the
Stringextensions and the ability to parse single path string from aURLare deprecated.Usage
UIView+SVG
The easiest way to create an SVG image is to use the UIView extension:
Output:
Or you can add an SVG file to your Asset Catalog. You should add it as a Data Asset like this:
Then use the same initializer as above:
Output:
You can also create a new UIView from a remote
URL:Output:
SwiftSVG provides the following
UIViewconvenience initializers:All of these initializers will parse a file located in the main bundle, a bundle of your own choosing, or on the web. It will parse the file asynchronously and optionally takes a completion block, passing a
SVGLayerafter parsing has been completed. Whether you pass a completion block or not, SwiftSVG will add it to the view’s sublayers. If you want to change one of the layer’s attributes, such as the fill color or resize it to fit a view, you can do that in the completion blockYou can optionally pass an
SVGParserobject if you want to reuse the same parser for various SVG files or want to roll your own using a third-party XML parser. By default, SwiftSVG uses a subclass of Foundation’sXMLParserusing all the supported elements and attributes calledNSXMLSVGParser. You can also optionally setup your ownNSXMLSVGParserpassing aSVGParserSupportedElementsstruct that will parse only the elements and attributes of your choosing.There is also a convenience initializer to parse a single path string, which parses synchronously:
Output:
CALayer+SVG
If you need a little bit more control over your parsed layer, you can use one of the
CALayerconvenience initalizers. You can make some changes to the parsed SVG layer, such as changing the fill color at runtime, and can add it to a layer of your own choosing. If you are dropping down to theCALayerlevel, it is assumed that you want more control and you must provide a completion block and you must add it to a sublayer to display it.Output:
You can create a new
CALayerfromURLorData:SVGLayer
The layer that is passed in the
UIViewandCALayercompletion blocks is an instance ofSVGLayerwhich is a subclass ofCAShapeLayer. Currently,SVGLayeradds the following capabilities:boundingBoxproperty that is the minimumCGRectthat encloses all subpaths. Good for scaling the layer to fit a view.SVGLayer, which is useful for caching.Other Interfaces
CAShapeLayer & UIBezierPath Single Paths
In addition to the
UIViewextension that allows you to parse a single<path>dstring, you can use theCAShapeLayerorUIBezierPathconvenience initializers.Output:
Output:
SVGView
Finally, SwiftSVG provides a
UIViewsubclass that isIBInspectable. Simply add a view to your storyboard and use the SVGView subclass as your class name. Then put the name of your SVG file in your bundle in theIBInspectableproperty “SVGName”Credits
License
SwiftSVG is released under the MIT License.