-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #12 from Raizlabs/feature/ateliercw/improve_readme
Improved readme, minor project updates
- Loading branch information
Showing
8 changed files
with
134 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,36 +1,127 @@ | ||
| # RIGImageGallery | ||
| > An image gallery for iOS | ||
| [](https://travis-ci.org/Raizlabs/RIGImageGallery) | ||
| [](http://cocoapods.org/pods/RIGImageGallery) | ||
| [](http://cocoapods.org/pods/RIGImageGallery) | ||
| [](http://cocoapods.org/pods/RIGImageGallery) | ||
| [](https://github.com/Carthage/Carthage) | ||
|
|
||
| RIGImageGallery is an image gallery for iOS written in Swift. | ||
| RIGImageGallery is a photo gallery meant to provide most of the functionality of the image gallery in the system Photos app, and handle asynchronous loading of images. | ||
|
|
||
| The goal is to offer sensible defaults that takes care of most of building an image gallery automatically, and offer easy, block-based customization. | ||
| This library is part of the Raizlabs Interface Guidelines, which are UI components that offer sensible defaults to help a project get off the ground quickly with components that feel native to the platform, and with easy to use customization options. | ||
|
|
||
|  | ||
|
|
||
| ## Features | ||
|
|
||
| - [x] Swipe to advance | ||
| - [x] Pinch to zoom | ||
| - [x] Double tap to toggle 1:1 zoom | ||
| - [x] Single tap to hide the nav bar | ||
|
|
||
| ## Requirements | ||
|
|
||
| - iOS 9.0+ | ||
| - Xcode 8.0+ | ||
|
|
||
| ## Installation with CocoaPods | ||
|
|
||
| RIGImageGallery is available through [CocoaPods](http://cocoapods.org). To install | ||
| it, simply add the following line to your Podfile: | ||
| #### CocoaPods | ||
| RIGImageGallery is available through [CocoaPods](http://cocoapods.org). To install it, simply add the following line to your Podfile: | ||
|
|
||
| ```ruby | ||
| pod 'RIGImageGallery' | ||
| ``` | ||
|
|
||
| ## Installation with Carthage | ||
|
|
||
| RIGImageGallery is also compatible with [Carthage](https://github.com/Carthage/Carthage). To install it, simply add the following line to your Cartfile: | ||
| #### Carthage | ||
| Create a `Cartfile` that lists the framework and run `carthage update`. Follow the [instructions](https://github.com/Carthage/Carthage#if-youre-building-for-ios) to add `$(SRCROOT)/Carthage/Build/iOS/RIGImageGallery.framework` to an iOS project. | ||
|
|
||
| ```ogdl | ||
| github "Raizlabs/RIGImageGallery" | ||
| ``` | ||
|
|
||
| ## Author | ||
| #### Manually | ||
| 1. Download all of the `.swift` files in `RIGImageGallery/` and drop them into your project. | ||
| 2. Congratulations! | ||
|
|
||
| ## Usage example | ||
|
|
||
| To see a complete example of using the gallery, take a look at the [sample project](https://github.com/Raizlabs/RIGImageGallery/blob/develop/RIGImageGalleryDemo/View%20Controller/ViewController.swift). | ||
|
|
||
| ### Creating a Gallery from Image URLs | ||
|
|
||
| ```swift | ||
| func createPhotoGallery() -> RIGImageGalleryViewController { | ||
|
|
||
| let urls: [URL] = [ | ||
| "https://placehold.it/1920x1080", | ||
| "https://placehold.it/1080x1920", | ||
| "https://placehold.it/350x150", | ||
| "https://placehold.it/150x350", | ||
| ].flatMap(URL.init(string:)) | ||
|
|
||
| let rigItems = urls.map { _ in | ||
| RIGImageGalleryItem(placeholderImage: UIImage(named: "placeholder")) | ||
| } | ||
|
|
||
| let rigController = RIGImageGalleryViewController(images: rigItems) | ||
|
|
||
| Michael Skiba, mike.skiba@raizlabs.com | ||
| for (index, URL) in urls.enumerated() { | ||
| let request = imageSession.dataTask(with: URLRequest(url: URL)) { [weak rigController] data, _, error in | ||
| if let image = data.flatMap(UIImage.init), error == nil { | ||
| rigController?.images[index].image = image | ||
| } | ||
| } | ||
| request.resume() | ||
| } | ||
|
|
||
| return rigController | ||
| } | ||
| ``` | ||
|
|
||
| ### Presenting and Customizing the View Controller | ||
| ```swift | ||
| @objc func showGallery(_ sender: UIButton) { | ||
| let photoViewController = createPhotoGallery() | ||
| photoViewController.dismissHandler = dismissPhotoViewer | ||
| photoViewController.actionButtonHandler = actionButtonHandler | ||
| photoViewController.actionButton = UIBarButtonItem(barButtonSystemItem: .action, target: nil, action: nil) | ||
| photoViewController.traitCollectionChangeHandler = traitCollectionChangeHandler | ||
| photoViewController.countUpdateHandler = updateCount | ||
| let navigationController = UINavigationController(rootViewController: photoViewController) | ||
| present(navigationController, animated: true, completion: nil) | ||
| } | ||
|
|
||
| func dismissPhotoViewer(_ :RIGImageGalleryViewController) { | ||
| dismiss(animated: true, completion: nil) | ||
| } | ||
|
|
||
| func actionButtonHandler(_: RIGImageGalleryViewController, galleryItem: RIGImageGalleryItem) { | ||
| } | ||
|
|
||
| func updateCount(_ gallery: RIGImageGalleryViewController, position: Int, total: Int) { | ||
| gallery.countLabel.text = "\(position + 1) of \(total)" | ||
| } | ||
|
|
||
| func traitCollectionChangeHandler(_ photoView: RIGImageGalleryViewController) { | ||
| let isPhone = UITraitCollection(userInterfaceIdiom: .phone) | ||
| let isCompact = UITraitCollection(verticalSizeClass: .compact) | ||
| let allTraits = UITraitCollection(traitsFrom: [isPhone, isCompact]) | ||
| photoView.doneButton = photoView.traitCollection.containsTraits(in: allTraits) ? nil : UIBarButtonItem(barButtonSystemItem: .done, target: nil, action: nil) | ||
| } | ||
| ``` | ||
|
|
||
| ## Contributing | ||
|
|
||
| Issues and pull requests are welcome! Please ensure that you have the latest [SwiftLint](https://github.com/realm/SwiftLint) installed before committing and that there are no style warnings generated when building. | ||
|
|
||
| Contributors are expected to abide by the [Contributor Covenant Code of Conduct](https://github.com/Raizlabs/RIGImageGallery/blob/develop/CONTRIBUTING.md). | ||
|
|
||
| ## License | ||
|
|
||
| RIGImageGallery is available under the MIT license. See the LICENSE file for more info. | ||
|
|
||
| ## Author | ||
|
|
||
| Michael Skiba, <mailto:mike.skiba@raizlabs.com> [@atelierclkwrk](https://twitter.com/atelierclkwrk) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.