base on High performance GIF engine [](http://swift.org) [](https://img.shields.io/cocoapods/v/SwiftyGif.svg) [](https://github.com/Carthage/Carthage) [](https://travis-ci.org/kirualex/SwiftyGif) [](https://raw.githubusercontent.com/kirualex/SwiftyGif/master/LICENSE) # SwiftyGif High performance & easy to use Gif engine <p align="center"> </br> <img src="https://github.com/kirualex/SwiftyGif/blob/master/example.gif" align="center" /> </p> > Language Switch: [한국어](README_KR.md) ## Features - [x] UIImage and UIImageView extension based - [x] Remote GIFs with customizable loader - [x] Great CPU/Memory performances - [x] Control playback - [x] Allow control of display quality by using 'levelOfIntegrity' - [x] Allow control CPU/memory tradeoff via 'memoryLimit' ## Installation ### With CocoaPods ```ruby source 'https://github.com/CocoaPods/Specs.git' use_frameworks! pod 'SwiftyGif' ``` ### With Carthage Follow the usual Carthage instructions on how to [add a framework to an application](https://github.com/Carthage/Carthage#adding-frameworks-to-an-application). When adding SwiftyGif among the frameworks listed in `Cartfile`, apply its syntax for [GitHub repositories](https://github.com/Carthage/Carthage/blob/master/Documentation/Artifacts.md#github-repositories): ``` github "kirualex/SwiftyGif" ``` ### With Swift Package Manager ```ruby https://github.com/kirualex/SwiftyGif.git ``` ## How to Use ### Project files  As of now, Xcode `xcassets` folders do not recognize `.gif` as images. This means you need to put your `.gif` outside of the assets. I recommend creating a group `gif` for instance. ### Quick Start SwiftyGif uses familiar `UIImage` and `UIImageView` to display gifs. #### Programmaticaly ```swift import SwiftyGif do { let gif = try UIImage(gifName: "MyImage.gif") let imageview = UIImageView(gifImage: gif, loopCount: 3) // Will loop 3 times imageview.frame = view.bounds view.addSubview(imageview) } catch { print(error) } ``` #### Directly from nib/storyboard ```swift @IBOutlet var myImageView : UIImageView! ... let gif = try UIImage(gifName: "MyImage.gif") self.myImageView.setGifImage(gif, loopCount: -1) // Will loop forever ``` #### Remote GIFs ```swift // You can also set it with an URL pointing to your gif let url = URL(string: "...") let loader = UIActivityIndicatorView(style: .white) cell.gifImageView.setGifFromURL(url, customLoader: loader) ``` #### SwiftUI Add this `UIViewRepresentable` to your code. ```swift struct AnimatedGifView: UIViewRepresentable { @Binding var url: URL func makeUIView(context: Context) -> UIImageView { let imageView = UIImageView(gifURL: self.url) imageView.contentMode = .scaleAspectFit return imageView } func updateUIView(_ uiView: UIImageView, context: Context) { uiView.setGifFromURL(self.url) } } ``` Then to use it: ```swift AnimatedGifView(url: Binding(get: { myModel.gif.url }, set: { _ in })) ``` ### Performances A `SwiftyGifManager` can hold one or several UIImageView using the same memory pool. This allows you to tune the memory limits to your convenience. If no manager is declared, SwiftyGif will just use the `SwiftyGifManager.defaultManager`. #### Level of integrity Setting a lower level of integrity will allow for frame skipping, lowering both CPU and memory usage. This can be a good option if you need to preview a lot of gifs at the same time. ```swift do { let gif = try UIImage(gifName: "MyImage.gif", levelOfIntegrity:0.5) } catch { print(error) } ``` ### Controls SwiftyGif offers various controls on the current `UIImageView` playing your gif file. ```swift self.myImageView.startAnimatingGif() self.myImageView.stopAnimatingGif() self.myImageView.showFrameAtIndexDelta(delta: Int) self.myImageView.showFrameAtIndex(index: Int) ``` To allow easy use of those controls, some utility methods are provided : ```swift self.myImageView.isAnimatingGif() // Returns whether the gif is currently playing self.myImageView.gifImage!.framesCount() // Returns number of frames for this gif ``` ### Delegate You can declare a SwiftyGifDelegate to receive updates on the gif lifecycle. For instance, if you want your controller `MyController` to act as the delegate: ```swift override func viewDidLoad() { super.viewDidLoad() self.imageView.delegate = self } ``` Then simply add an extension: ```swift extension MyController : SwiftyGifDelegate { func gifURLDidFinish(sender: UIImageView) { print("gifURLDidFinish") } func gifURLDidFail(sender: UIImageView) { print("gifURLDidFail") } func gifDidStart(sender: UIImageView) { print("gifDidStart") } func gifDidLoop(sender: UIImageView) { print("gifDidLoop") } func gifDidStop(sender: UIImageView) { print("gifDidStop") } } ``` ## Benchmark ### Display 1 Image | |CPU Usage(average) |Memory Usage(average) | |:-------------:|:-----------------:|:-----------------------:| |FLAnimatedImage|35% |9,5Mb | |SwiftyGif |2% |18,4Mb | |SwiftyGif(memoryLimit:10)|34% |9,5Mb | ### Display 6 Images | |CPU Usage(average) |Memory Usage(average) | |:-------------:|:-----------------:|:-----------------------:| |FLAnimatedImage|65% |25,1Mb | |SwiftyGif |22% |105Mb | |SwiftyGif(memoryLimit:20)|45% |26Mb | Measured on an iPhone 6S, iOS 9.3.1 and Xcode 7.3. ", Assign "at most 3 tags" to the expected json: {"id":"12283","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"