https://github.com/unsplash/unsplash-photopicker-ios
📱An iOS photo picker to search and download photos from Unsplash.
https://github.com/unsplash/unsplash-photopicker-ios
ios photo-browser swift unsplash
Last synced: 7 months ago
JSON representation
📱An iOS photo picker to search and download photos from Unsplash.
- Host: GitHub
- URL: https://github.com/unsplash/unsplash-photopicker-ios
- Owner: unsplash
- License: mit
- Created: 2018-10-05T14:21:44.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-03T10:51:15.000Z (over 2 years ago)
- Last Synced: 2025-04-03T04:13:55.264Z (7 months ago)
- Topics: ios, photo-browser, swift, unsplash
- Language: Swift
- Homepage:
- Size: 132 KB
- Stars: 412
- Watchers: 9
- Forks: 86
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Unsplash Photo Picker for iOS
[](https://cocoapods.org/pods/UnsplashPhotoPicker)
[](https://github.com/apple/swift-package-manager)
[](https://github.com/Carthage/Carthage)
[](https://github.com/unsplash/unsplash-photopicker-ios)
[](https://github.com/unsplash/unsplash-photopicker-ios)
UnsplashPhotoPicker is an iOS UI component that allows you to quickly search the Unsplash library for free high-quality photos with just a few lines of code.
Android photo picker [here](https://github.com/unsplash/unsplash-photopicker-android).
## Table of Contents
- [Description](#description)
- [Requirements](#requirements)
- [Installation](#installation)
- [Swift Package Manager](#swift-package-manager)
- [Carthage](#carthage)
- [CocoaPods](#cocoapods)
- [Git submodule](#git-submodule)
- [Usage](#usage)
- [Configuration](#configuration)
- [Presenting](#presenting)
- [Using the results](#using-the-results)
- [License](#license)
## Description
UnsplashPhotoPicker is a view controller. You present it to offer your users to select one or multiple photos from Unsplash. Once they have selected photos, the view controller returns `UnsplashPhoto` objects that you can use in your app.
## Requirements
- iOS 12.1+
- Xcode 12.5+
- Swift 5.3+
- [Unsplash API Access Key and Secret Key](https://unsplash.com/documentation#registering-your-application)
⚠️ UnsplashPhotoPicker is not compatible with Objective-C.
## Installation
### Swift Package Manager
To integrate UnsplashPhotoPicker into your Xcode project using [Swift Package Manager](https://github.com/apple/swift-package-manager), open dependency manager through `File > Swift Packages > Add Package Dependency...`.
and insert repository URL:
`https://github.com/unsplash/unsplash-photopicker-ios.git`
To add dependency in your own package, just specify it in dependencies of your `Package.swift`:
```swift
.package(
name: "UnsplashPhotoPicker",
url: "https://github.com/unsplash/unsplash-photopicker-ios.git",
.upToNextMajor(from: "1.3.0")
)
```
### Carthage
To integrate UnsplashPhotoPicker into your Xcode project using [Carthage](https://github.com/Carthage/Carthage), specify it in your `Cartfile`:
```ogdl
github "unsplash/unsplash-photopicker-ios" ~> 1.3
```
Run `carthage update` to build the framework and drag the built `UnsplashPhotoPicker.framework` into your Xcode project.
### CocoaPods
To integrate UnsplashPhotoPicker into your Xcode project using [CocoaPods](https://cocoapods.org), specify it in your `Podfile`:
```ruby
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '12.1'
use_frameworks!
target '' do
pod 'UnsplashPhotoPicker', '~> 1.3'
end
```
Then run `pod install`.
### Git submodule
If you prefer not to use any of the aforementioned dependency managers, you can integrate UnsplashPhotoPicker into your project manually as a [git submodule](https://git-scm.com/docs/git-submodule) by running the following command in the project's folder:
```bash
$ git submodule add https://github.com/unsplash/unsplash-photopicker-ios.git
```
Drag the `UnsplashPhotoPicker.xcodeproj` file into your Xcode project, then drag the `UnsplashPhotoPicker.framework` to your target's "Embedded Binaries".
## Usage
❗️Before you get started, you need to register as a developer on our [Developer](https://unsplash.com/developers) portal. Once registered, create a new app to get an **Access Key** and a **Secret Key**.
### Configuration
The `UnsplashPhotoPicker` is configured with an instance of `UnsplashPhotoPickerConfiguration`:
```swift
UnsplashPhotoPickerConfiguration(accessKey: String,
secretKey: String,
query: String,
allowsMultipleSelection: Bool,
memoryCapacity: Int,
diskCapacity: Int)
```
| Property | Type | Optional/Required | Default |
| ----------------------------- | -------------------- | ----------------- | ------- |
| **`accessKey`** | _String_ | Required | N/A |
| **`secretKey`** | _String_ | Required | N/A |
| **`query`** | _String_ | Optional | `nil` |
| **`allowsMultipleSelection`** | _Bool_ | Optional | `false` |
| **`memoryCapacity`** | _Int_ | Optional | `50` |
| **`diskCapacity`** | _Int_ | Optional | `100` |
| **`contentFilterLevel`** | _ContentFilterLevel_ | Optional | `.low` |
### Presenting
`UnsplashPhotoPicker` is a subclass of `UINavigationController`. We recommend that you present it modally or as a popover on iPad. Before presenting it, you need to implement the `UnsplashPhotoPickerDelegate` protocol, and use the `photoPickerDelegate` property to get the results.
```swift
protocol UnsplashPhotoPickerDelegate: class {
func unsplashPhotoPicker(_ photoPicker: UnsplashPhotoPicker, didSelectPhotos photos: [UnsplashPhoto])
func unsplashPhotoPickerDidCancel(_ photoPicker: UnsplashPhotoPicker)
}
```
### Using the results
`UnsplashPhotoPicker` returns an array of `UnsplashPhoto` objects. See [UnsplashPhoto.swift](UnsplashPhotoPicker/UnsplashPhotoPicker/Classes/Models/UnsplashPhoto.swift) for more details.
## License
MIT License
Copyright (c) 2018-2022 Unsplash Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.