nytimes/NYTPhotoViewer

NYTPhotoViewer

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

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 = [[NYTPhotosViewController alloc] initWithPhotos:photos];
[self presentViewController:photosViewController animated:YES completion:nil];

Running the Example

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

Installation

Swift Package Manager

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

Cocoapods

NYTPhotoViewer is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'NYTPhotoViewer'

Carthage

NYTPhotoViewer may be installed via Carthage. To install it, simply add the following line to your Cartfile:

github "NYTimes/NYTPhotoViewer"

Then, following the instructions for integrating Carthage frameworks into your app, link the NYTPhotoViewer and PINRemoteImage frameworks into your project.

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

Requirements

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

Changelog

See CHANGELOG.md.

Contributing

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

Swift

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.

Inspiration

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

Implementation

NYTPhotoViewer has a straightforward implementation using standard UIKit components. The viewer is a UIViewController and uses UIViewController transitioning APIs for the animated and interactive transitions, a UIPageViewController for horizontal swiping between images, and UIScrollView for image zooming.

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

License

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

Contributors

A list of contributors is available through GitHub.