eyaldar/auk

An image slideshow for iOS written in Swift.

Auk, an image slideshow for iOS / Swift

[][carthage] [][cocoadocs] [][cocoadocs] [cocoadocs]: http://cocoadocs.org/docsets/Auk [carthage]: https://github.com/Carthage/Carthage

This is an iOS library that shows an image carousel with a page indicator. Users can scroll through local and remote images or watch them scroll automatically.

• Allows to specify placeholder and error images for remote sources.
• Includes ability to simulate and verify image download in unit tests.
• Supports animated transition during screen orientation change.
• Includes image caching.
• Supports right-to-left languages.

Drawing of the great auk by John Gerrard Keulemans, circa 1900. Source: Wikimedia Commons.

Setup

There are three ways you can add Auk to your Xcode project.

Add source (iOS 7+)

Simply add two files to your project:

1. Moa image downloader MoaDistrib.swift.
2. Auk image slideshow AukDistrib.swift.

Setup with Carthage (iOS 8+)

1. Add github "evgenyneu/Auk" ~> 2.0 to your Cartfile.
2. Run carthage update.
3. Add moa and Auk frameworks into your project.

Setup with CocoaPods (iOS 8+)

If you are using CocoaPods add this text to your Podfile and run pod install.

use_frameworks!
pod 'Auk', '~> 2.0'

Setup in Xcode 6

Auk is written in Swift 2.0 for Xcode 7. See Swift 1.2 setup instuctions for Xcode 6 projects.

Usage

1. Add import Auk to your source code if you used Carthage or CocoaPods setup methods.
2. Add a scroll view to the storyboard and create an outlet property scrollView in your view controller.
3. Clear the Adjust Scroll View Insets checkbox in the Attribute Inspector of your view controller.

Auk extends UIScrollView class by creating the auk property.

// Show remote image
scrollView.auk.show(url: "http://site.com/bird.jpg")

// Show local image
if let image = UIImage(named: "bird.jpg") {
  scrollView.auk.show(image: image)
}

// Remove all images
scrollView.auk.removeAll()

// Return the number of pages in the scroll view
scrollView.auk.numberOfPages

// Get the index of the current page
scrollView.auk.currentPageIndex

// Return currently displayed images
scrollView.auk.images

Scrolling from code

// Scroll to page
scrollView.auk.scrollTo(2, animated: true)

// Scroll to the next page
scrollView.auk.scrollToNextPage()

// Scroll to the previous page
scrollView.auk.scrollToPreviousPage()

Auto scrolling

// Scroll images automatically with the interval of 3 seconds
scrollView.auk.startAutoScroll(delaySeconds: 3)

// Stop auto-scrolling of the images
scrollView.auk.stopAutoScroll()

Accessibility

One can pass an image description when calling the show methods. This description will be spoken by the device in accessibility mode for the current image on screen.

// Supply accessibility label for the image
scrollView.auk.show(url: "http://site.com/bird.jpg", accessibilityLabel: "Picture of a bird.")

Loading images from insecure HTTP hosts

If your remote image URLs are not https you will need to add an exception to the Info.plist file. This will allow the App Transport Security to load the images from insecure HTTP hosts.

Configuration

Use the auk.settings property to configure behavior and appearance of the scroll view before showing the images. See the configuration manual for the complete list of configuration options.

// Make the images fill entire page
scrollView.auk.settings.contentMode = UIViewContentMode.ScaleAspectFill

// Set background color of page indicator
scrollView.auk.settings.pageControl.backgroundColor = UIColor.grayColor().colorWithAlphaComponent(0.3)

// Show placeholder image while remote image is being downloaded.
scrollView.auk.settings.placeholderImage = UIImage(named: "placeholder.jpg")

// Show an image after specifying the settings
scrollView.auk.show(url: "http://site.com/bird.jpg")

Size change animation

Read size animation manual if you need to animate the scroll view during device orientation change.

Image caching

Auk uses moa image downloader for getting remote images. You can configure its caching settings by changing the Moa.settings.cache.requestCachePolicy property. Add import moa to your source code if you used Carthage or CocoaPods setup methods.

import moa

// ...

// By default images are cached according to their response HTTP headers.
Moa.settings.cache.requestCachePolicy = .UseProtocolCachePolicy

// Use local cache regardless of response HTTP headers.
Moa.settings.cache.requestCachePolicy = .ReturnCacheDataElseLoad

Note: moa image downloader offers other features including request logging and HTTP settings.

Remote image unit testing

One can simulate and verify remote image download in your unit tests. Please refer to the moa unit testing manual for more information. Add import moa to your source code if you used Carthage or CocoaPods setup methods.

// Autorespond with the given image
MoaSimulator.autorespondWithImage("www.site.com", image: UIImage(named: "35px.jpg")!)

Scroll view delegate

If you need to assign a delegate to the scroll view please do so before accessing scrollView.auk property.

Respond to image tap

Here is what you need to do to add an image tap handler to the scroll view.

1. In the Storyboard drag a Tag Gesture Recognizer into your scroll view.
2. Show assistant editor with your view controller code.
3. Do the control-drag from the tap gesture recognizer in the storyboard into your view controller code.
4. A dialog will appear, change the Connection to action and enter the name of the method.
5. This method will be called when the scroll view is tapped. Use the auk.currentPageIndex property of your scroll view to get the index of the current page.

Demo app

The project includes a demo iOS app.

Alternative solutions

Here is a list of other image slideshow libraries for iOS.

• kimar/KIImagePager
• kirualex/KASlideShow
• nicklockwood/iCarousel
• nicklockwood/SwipeView
• paritsohraval100/PJR-ScrollView-Slider

Credits

• The Great Auk drawing by John James Audubon, 1827-1838. Source: Wikimedia Commons.
• Great auk with juvenile drawing by John Gerrard Keulemans, circa 1900. Source: Wikimedia Commons.
• The Great Auk drawing from Popular Science Monthly Volume 62, 1902-1903. Source: Wikimedia Commons.
• Great Auk egg, U. S. National Museum, in a book by Arthur Cleveland Bent, 1919. Source: Wikimedia Commons.
• Only known illustration of a Great Auk frawn from life by Olaus Wormius, 1655. Source: Wikimedia Commons.
• The Great Auks at Home, oil on canvas by John Gerrard Keulemans. Source: Wikimedia Commons.
• Alca impennis by John Gould: The Birds of Europe, vol. 5 pl. 55, 19th century. Source: Wikimedia Commons.
• Great Auks in summer and winter plumage by John Gerrard Keulemans, before 1912. Source: Wikimedia Commons.

License

Auk is released under the MIT License.

Feedback is welcome

If you notice any issue, got stuck or just want to chat feel free to create an issue. I will be happy to help you.

•ᴥ•

This code is dedicated to the great auk, a flightless bird that became extinct in the mid-19th century.