Repository files navigation

Customizable Swift image slideshow with circular scrolling, timer and full screen viewer

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

ImageSlideshow is available throughCocoaPods. To installit, simply add the following line to your Podfile:

pod'ImageSlideshow','~> 1.9.0'

To integrate ImageSlideshow into your Xcode project using Carthage, specify it in your Cartfile:

github"zvonicek/ImageSlideshow" ~>1.9.0

Carthage does not include InputSources for external providers (due to dependency on those providers) so you need to grab the one you need fromImageSlideshow/Classes/InputSources manually.

One possibility is to download a built framework (ImageSlideshow.framework.zip) fromreleases page and link it with your project (underLinked Frameworks and Libraries in your target). This is, however, currently problematic because of rapid Swift development -- the framework is built for a single Swift version and may not work on previous/future versions.

Alternatively can also grab the wholeImageSlideshow directory and copy it to your project. Be sure to remove those external Input Sources you don't need.

Note on Swift 2.3, Swift 3 and Swift 4 support

Version 1.4 supports Swift 4. Swift 3 is supported from version 1.0, for Swift 2.2 and Swift 2.3 compatible code use version 0.6 or branchswift-2.3.

Add ImageSlideshow view to your view hiearchy either in Interface Builder or in code.

Set images by usingsetImageInputs method onImageSlideshow instance with an array ofInputSources. By default you can useImageSource which takesUIImage or few otherInputSources for most popular networking libraries. You can also create your own input source by implementingInputSource protocol.

slideshow.setImageInputs([ImageSource(image:UIImage(named:"myImage"))!,ImageSource(image:UIImage(named:"myImage2"))!,AlamofireSource(urlString:"https://images.unsplash.com/photo-1432679963831-2dab49187847?w=1080"),KingfisherSource(urlString:"https://images.unsplash.com/photo-1432679963831-2dab49187847?w=1080"),ParseSource(file:PFFile(name:"image.jpg", data:data))])

Behaviour is configurable by those properties:

• slideshowInterval - slideshow interval in seconds (default0 – disabled)
• zoomEnabled - enables zooming (defaultfalse)
• circular - enables circular scrolling (defaulttrue)
• activityIndicator – allows to set custom activity indicator, seeActivity indicator section
• pageIndicator – allows to set custom page indicator, seePage indicator section; assignnil to hide page indicator
• pageIndicatorPosition - configures position of the page indicator
• contentScaleMode - configures the scaling (defaultScaleAspectFit)
• draggingEnabled - enables dragging (defaulttrue)
• currentPageChanged - closure called on page change
• willBeginDragging - closure called on scrollViewWillBeginDragging
• didEndDecelerating - closure called on scrollViewDidEndDecelerating
• preload - image preloading configuration (defaultall preloading, alsofixed)

Page indicator can be customized using thepageIndicator property on ImageSlideshow. By defualt, a plain UIPageControl is used. If needed, page control can be customized:

letpageIndicator=UIPageControl()pageIndicator.currentPageIndicatorTintColor=UIColor.lightGraypageIndicator.pageIndicatorTintColor=UIColor.blackslideshow.pageIndicator= pageIndicator

Also, a simple label page indicator that shows pages in style "5/21" (fifth page from twenty one) is provided:

slideshow.pageIndicator=LabelPageIndicator()

You can also use your own page indicator by adopting thePageIndicatorView protocol.

Position of the page indicator can be configured by assigning aPageIndicatorPosition value to thepageIndicatorPosition property on ImageSlideshow. You may specify the horizontal and vertical positioning separately.

Horizontal positioning options are:.left(padding: Int),.center,.right(padding: Int)

Vertical positioning options are:.top,.bottom,.under,customTop(padding: Int),customBottom(padding: Int),customUnder(padding: Int)

Example:

slideshow.pageIndicatorPosition=PageIndicatorPosition(horizontal:.left(padding:20), vertical:.bottom)

By default activity indicator is not shown, but you can enable it by settingDefaultActivityIndicator instance to Image Slideshow:

slideshow.activityIndicator=DefaultActivityIndicator()

You can customize style and color of the indicator:

slideshow.activityIndicator=DefaultActivityIndicator(style:.white, color:nil)

There's also an option to use your own activity indicator. You just need to implementActivityIndicatorView andActivityIndicatorFactory protocols. SeeActivityIndicator.swift for more information.

There is also a possibility to open full-screen image view using attachedFullScreenSlideshowViewController. The simplest way is to call:

overridefunc viewDidLoad(){letgestureRecognizer=UITapGestureRecognizer(target:self, action: #selector(ViewController.didTap))  slideshow.addGestureRecognizer(gestureRecognizer)}func didTap(){  slideshow.presentFullScreenController(from:self)}

FullScreenSlideshowViewController can also be instantiated and configured manually if more advanced behavior is needed.

Petr Zvoníček

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

Inspired by projects:

• https://github.com/gonzalezreal/Vertigo
• https://github.com/kimar/KIImagePager