Repository files navigation

NYTPhotoViewer is a slideshow and image viewer that includes double-tap to zoom, captions, support for multiple images, interactive flick to dismiss, animated zooming presentation, and more.

Usage is simple, with the option for more complicated customization when needed through a delegate relationship. In the most basic implementation, just initialize the view controller with an array of photo objects and present it as normal:

NYTPhotosViewController *photosViewController = [[NYTPhotosViewControlleralloc]initWithPhotos:photos];[selfpresentViewController:photosViewControlleranimated:YEScompletion:nil];

Clone this locally, then in your local workspace of theNYTPhotoViewer repo, run./scripts/bootstrap, then open Examples/NYTPhotoViewer.xcworkspace. You'll see targets for a Swift and Objective-C app.

NYTPhotoViewer may be installed via SPM, by pointing at this repo's URL.

NYTPhotoViewer is available throughCocoaPods. To install it, simply add the following line to yourPodfile:

pod'NYTPhotoViewer'

NYTPhotoViewer may be installed viaCarthage. To install it, simply add the following line to yourCartfile:

github "NYTimes/NYTPhotoViewer"

Then, following the instructions forintegrating Carthage frameworks into your app, link theNYTPhotoViewer andPINRemoteImage frameworks into your project.

If you don't want support for animated GIFs, you may instead link against only theNYTPhotoViewerCore framework.

This library requires a deployment target of iOS 9.0 or greater.

SeeCHANGELOG.md.

Pleaseopen pull requests against thedevelop branch, and add a relevant note to thedevelop section of the CHANGELOG as part of your pull request.

NYTPhotoViewer is written in Objective-C but is fully interoperable with Swift. If you experience any interoperability difficulties, please open an issue or pull request and we will work to resolve it.

NYTPhotoViewer draws feature inspiration from Facebook and Tweetbot’s image viewers. If this implementation isn’t to your liking, you may considerJTSImageViewController orIDMPhotoBrowser.

NYTPhotoViewer has a straightforward implementation using standard UIKit components. The viewer is aUIViewController and usesUIViewController transitioning APIs for the animated and interactive transitions, aUIPageViewController for horizontal swiping between images, andUIScrollView for image zooming.

It is intended to be used without the need for subclassing, and as such it accepts model objects conforming to aNYTPhoto protocol and provides ample opportunity for customization via theNYTPhotosViewControllerDelegate. Since standard APIs are used, the client has full control over the transitions and customization of theNYTPhotosViewController.

NYTPhotoViewer is available under the Apache 2.0 license. SeeLICENSE.md for more information.

A list of contributors is available through GitHub.