SKPhotoBrowser

Simple PhotoBrowser/Viewer inspired by facebook, twitter photo browsers written by swift, based on IDMPhotoBrowser, MWPhotoBrowser.

features

• Display one or more images by providing either UIImage objects, or string of URL array.
• Photos can be zoomed and panned, and optional captions can be displayed
• Minimalistic Facebook-like interface, swipe up/down to dismiss
• Ability to custom control. (hide/ show toolbar for controls, / swipe control)
• Handling and caching photos from web
• Landscape handling
• Delete photo support(by offbye). By set displayDelete=true show a delete icon in statusbar, deleted indexes can be obtain from delegate func didDeleted

Requirements

• iOS 8.0+
• Swift 2.0+
• ARC

##Installation

####CocoaPods available on CocoaPods. Just add the following to your project Podfile:

pod 'SKPhotoBrowser'
use_frameworks!

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

github "suzuki-0000/SKPhotoBrowser"

####Manually Add the code directly into your project.

##Usage See the code snippet below for an example of how to implement, or see the example project.

from UIImages:

// 1. create SKPhoto Array from UIImage
var images = [SKPhoto]()
let photo = SKPhoto.photoWithImage(UIImage())// add some UIImage
images.append(photo) 

// 2. create PhotoBrowser Instance, and present from your viewController. 
let browser = SKPhotoBrowser(photos: images)
browser.initializePageIndex(0)
presentViewController(browser, animated: true, completion: {})

from URLs:

// 1. create URL Array 
var images = [SKPhoto]()
let photo = SKPhoto.photoWithImageURL("https://placehold.jp/150x150.png")
photo.shouldCachePhotoURLImage = false // you can use image cache by true(NSCache)
images.append(photo)

// 2. create PhotoBrowser Instance, and present. 
let browser = SKPhotoBrowser(photos: images)
browser.initializePageIndex(0)
presentViewController(browser, animated: true, completion: {})

from local files:

// 1. create images from local files
var images = [SKLocalPhoto]()
let photo = SKLocalPhoto.photoWithImageURL("..some_local_path/150x150.png")
images.append(photo)

// 2. create PhotoBrowser Instance, and present. 
let browser = SKPhotoBrowser(photos: images)
browser.initializePageIndex(0)
presentViewController(browser, animated: true, completion: {})

If you want to use zooming effect from an existing view, use another initializer:

// e.g.: some tableView or collectionView.
func collectionView(collectionView: UICollectionView, didSelectItemAtIndexPath indexPath: NSIndexPath) {
   let cell = collectionView.cellForItemAtIndexPath(indexPath) 
   let originImage = cell.exampleImageView.image // some image for baseImage 

   let browser = SKPhotoBrowser(originImage: originImage, photos: images, animatedFromView: cell) 
   browser.initializePageIndex(indexPath.row)
   presentViewController(browser, animated: true, completion: {})
}

Custom

Toolbar

You can customize Toolbar via SKPhotoBrowserOptions.

• displayCounterLabel (default is true)
• displayBackAndForwardButton (default is true)
• displayAction (default is true)

SKPhotoBrowserOptions.displayToolbar = false                // all tool bar will be hidden
SKPhotoBrowserOptions.displayCounterLabel = false           // counter label will be hidden
SKPhotoBrowserOptions.displayBackAndForwardButton = false   // back / forward button will be hidden
SKPhotoBrowserOptions.displayAction = false                 // action button will be hidden
SKPhotoBrowserOptions.displayDeleteButton = true            // delete button will be shown
let browser = SKPhotoBrowser(originImage: originImage, photos: images, animatedFromView: cell)

CustomButton Image

Close button is able to change image and frame.

browser.displayCustomCloseButton = true // custom close button will be enable
browser.customCloseButtonImage = UIImage(named: "some.png")
browser.customCloseButtonShowFrame = CGRect()
browser.customCloseButtonHideFrame = CGRect()

Delete button is able to change image and frame.

browser.displayCustomDeleteButton = true // custom delete button will be enable
browser.customDeleteButtonImage = UIImage(named: "some.png")
browser.customDeleteButtonShowFrame = CGRect()
browser.customDeleteButtonHideFrame = CGRect()

Delete

You can delete your photo for your own hanlding.

Photo Captions

Photo captions can be displayed simply bottom of PhotoBrowser. by setting the caption property on specific photos:

let photo = SKPhoto.photoWithImage(UIImage())
photo.caption = "Lorem Ipsum is simply dummy text of the printing and typesetting industry."
images.append(photo)

SwipeGesture

vertical swipe can enable/disable:

let browser = SKPhotoBrowser(originImage: originImage, photos: images, animatedFromView: cell)
browser.disableVerticalSwipe = true 

Delegate

There's some trigger point you can handle using delegate. those are optional.

• didShowPhotoAtIndex(index:Int)
• willDismissAtPageIndex(index:Int)
• willShowActionSheet(photoIndex: Int)
• didDismissAtPageIndex(index:Int)
• didDismissActionSheetWithButtonIndex(buttonIndex: Int, photoIndex: Int)
• didScrollToIndex(index: Int)
• removePhoto(browser: SKPhotoBrowser, index: Int, reload: (() -> Void))
• viewForPhoto(browser: SKPhotoBrowser, index: Int) -> UIView?

let browser = SKPhotoBrowser(originImage: originImage, photos: images, animatedFromView: cell)
browser.delegate = self

// MARK: - SKPhotoBrowserDelegate
func didShowPhotoAtIndex(index: Int) {
// when photo will be shown
}

func willDismissAtPageIndex(index: Int) {
// when PhotoBrowser will be dismissed
}

func didDismissAtPageIndex(index: Int) {
// when PhotoBrowser did dismissed
}

Minor Option

• blackArea handling which is appearing outside of photo
• single tap handling, dismiss/noaction
• bounce animation when appearing/dismissing

enableZoomBlackArea    = true  // default true
enableSingleTapDismiss = true  // default false
bounceAnimation        = true  // default false

Photos from

• Unsplash

License

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