Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zvonicek/imageslideshow

Swift image slideshow with circular scrolling, timer and full screen viewer
https://github.com/zvonicek/imageslideshow

gallery image ios slideshow swift

Last synced: 5 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/zvonicek/imageslideshow
Owner: zvonicek
License: mit
Created: 2015-09-01T20:38:29.000Z (about 9 years ago)
Default Branch: master
Last Pushed: 2024-08-14T15:34:32.000Z (3 months ago)
Last Synced: 2024-10-30T07:53:04.462Z (14 days ago)
Topics: gallery, image, ios, slideshow, swift
Language: Swift
Homepage:
Size: 1.32 MB
Stars: 1,778
Watchers: 38
Forks: 475
Open Issues: 74
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # 🖼 ImageSlideshow

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

[![Build Status](https://www.bitrise.io/app/9aaf3e552f3a575c.svg?token=AjiVckTN9ItQtJs873mYMw&branch=master)](https://www.bitrise.io/app/9aaf3e552f3a575c)

[![Version](https://img.shields.io/cocoapods/v/ImageSlideshow.svg?style=flat)](http://cocoapods.org/pods/ImageSlideshow)

[![Carthage Compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

[![License](https://img.shields.io/cocoapods/l/ImageSlideshow.svg?style=flat)](http://cocoapods.org/pods/ImageSlideshow)

[![Platform](https://img.shields.io/cocoapods/p/ImageSlideshow.svg?style=flat)](http://cocoapods.org/pods/ImageSlideshow)

![](https://dzwonsemrish7.cloudfront.net/items/2R06283n040V3P3p0i42/ezgif.com-optimize.gif)

## 📱 Example

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

## 🔧 Installation

### CocoaPods

ImageSlideshow is available through [CocoaPods](http://cocoapods.org). To install

it, simply add the following line to your Podfile:

```ruby

pod 'ImageSlideshow', '~> 1.9.0'

```

### Carthage

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

```ruby

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 from `ImageSlideshow/Classes/InputSources` manually.

### Manually

One possibility is to download a built framework (ImageSlideshow.framework.zip) from [releases page](https://github.com/zvonicek/ImageSlideshow/releases/) and link it with your project (under`Linked 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 whole `ImageSlideshow` 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 branch *swift-2.3*.

## 🔨 How to use

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

### Loading images

Set images by using ```setImageInputs``` method on ```ImageSlideshow``` instance with an array of *InputSource*s. By default you can use ```ImageSource``` which takes ```UIImage``` or few other *InputSource*s for most popular networking libraries. You can also create your own input source by implementing ```InputSource``` protocol.

| Library                                                       | InputSource name | Pod                               |

| ------------------------------------------------------------- |:----------------:| ---------------------------------:|

| [AlamofireImage](https://github.com/Alamofire/AlamofireImage) | AlamofireSource  | `pod "ImageSlideshow/Alamofire"`  |

| [AFNetworking](https://github.com/AFNetworking/AFNetworking)  | AFURLSource      | `pod "ImageSlideshow/AFURL"`      |

| [SDWebImage](https://github.com/rs/SDWebImage)                | SDWebImageSource | `pod "ImageSlideshow/SDWebImage"` |

| [Kingfisher](https://github.com/onevcat/Kingfisher)           | KingfisherSource | `pod "ImageSlideshow/Kingfisher"` |

| [Parse](https://github.com/ParsePlatform/Parse-SDK-iOS-OSX)   | ParseSource      | `pod "ImageSlideshow/Parse"`      |

```swift

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))

])

```

### Configuration

Behaviour is configurable by those properties:

- ```slideshowInterval``` - slideshow interval in seconds (default `0` – disabled)

- ```zoomEnabled``` - enables zooming (default `false`)

- ```circular``` - enables circular scrolling (default `true`)

- ```activityIndicator``` – allows to set custom activity indicator, see *Activity indicator* section

- ```pageIndicator``` – allows to set custom page indicator, see *Page indicator* section; assign `nil` to hide page indicator

- ```pageIndicatorPosition``` - configures position of the page indicator

- ```contentScaleMode``` - configures the scaling (default `ScaleAspectFit`)

- ```draggingEnabled``` - enables dragging (default `true`)

- ```currentPageChanged``` - closure called on page change

- ```willBeginDragging``` - closure called on scrollViewWillBeginDragging

- ```didEndDecelerating``` - closure called on scrollViewDidEndDecelerating

- ```preload``` - image preloading configuration (default `all` preloading, also `fixed`)

### Page Indicator

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

```swift

let pageIndicator = UIPageControl()

pageIndicator.currentPageIndicatorTintColor = UIColor.lightGray

pageIndicator.pageIndicatorTintColor = UIColor.black

slideshow.pageIndicator = pageIndicator

```

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

```swift

slideshow.pageIndicator = LabelPageIndicator()

```

You can also use your own page indicator by adopting the `PageIndicatorView` protocol.

Position of the page indicator can be configured by assigning a `PageIndicatorPosition` value to the `pageIndicatorPosition` 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:

```swift

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

```

### Activity Indicator

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

```swift

slideshow.activityIndicator = DefaultActivityIndicator()

```

You can customize style and color of the indicator:

```swift

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

```

There's also an option to use your own activity indicator. You just need to implement `ActivityIndicatorView` and `ActivityIndicatorFactory` protocols. See `ActivityIndicator.swift` for more information.

### Full Screen view

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

```swift

override func viewDidLoad() {

  let gestureRecognizer = 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.

## 👤 Author

Petr Zvoníček

## 📄 License

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

## 👀 References

Inspired by projects:

- https://github.com/gonzalezreal/Vertigo

- https://github.com/kimar/KIImagePager