https://github.com/igooor-bb/justphotopicker
Simple and minimalistic photo picker for iOS written in Swift
https://github.com/igooor-bb/justphotopicker
cocoapods customizable gallery imagepicker images ios localization localized minimalistic package photopicker photos picker swift swiftui
Last synced: 4 months ago
JSON representation
Simple and minimalistic photo picker for iOS written in Swift
- Host: GitHub
- URL: https://github.com/igooor-bb/justphotopicker
- Owner: igooor-bb
- License: mit
- Created: 2021-07-16T16:39:40.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-08-24T21:50:03.000Z (about 3 years ago)
- Last Synced: 2025-05-31T08:36:25.096Z (5 months ago)
- Topics: cocoapods, customizable, gallery, imagepicker, images, ios, localization, localized, minimalistic, package, photopicker, photos, picker, swift, swiftui
- Language: Swift
- Homepage:
- Size: 6.99 MB
- Stars: 11
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# JustPhotoPicker
JustPhotoPicker is a simple and minimalistic photo picker for iOS written in Swift.
Initially, the project was made for personal purposes, but it was decided to make it publicly available for use and contribution in improvement.
Source of sample images in the gallery: [The Verge](https://www.theverge.com/pages/wallpapers)
## Contents
- [JustPhotoPicker](#justphotopicker)
- [Contents](#contents)
- [Requirements](#requirements)
- [Installation](#installation)
- [Using CocoaPods](#using-cocoapods)
- [Using Swift Package Manager](#using-swift-package-manager)
- [Info.plist](#infoplist)
- [Usage in UIKit](#usage-in-uikit)
- [Configuration](#configuration)
- [Processing the result](#processing-the-result)
- [Using the delegate](#using-the-delegate)
- [Using the closure](#using-the-closure)
- [Display](#display)
- [Usage in SwiftUI](#usage-in-swiftui)
- [Configuration properties](#configuration-properties)
- [Localization](#localization)
- [Contribution](#contribution)
- [License](#license)
## Requirements
- iOS/iPadOS 13.0+
- Xcode 11.0+
## Installation
### Using CocoaPods
You can use [CocoaPods](http://cocoapods.org/) to install `JustPhotoPicker` by adding folowing lines to your `Podfile`:
```ruby
platform :ios, '13.0'
use_frameworks!
target 'ApplicationName' do
pod 'JustPhotoPicker'
end
```
Then just write the command in the terminal to install:
```bash
$ pod install
```
### Using Swift Package Manager
You can use Swift Package Manager to install JustPhotoPicker using Xcode:
1. Open your project in Xcode
2. Open "File" -> "Swift Packages" -> "Add Package Dependency..."
3. Paste the repository URL:
4. Click "Next" a couple of times and finish adding
## Info.plist
To make your application have access to photos, add the following entity to the file `Info.plist`:
- Privacy - Photo Library Usage Description
```xml
NSPhotoLibraryUsageDescription
Some description
```
## Usage in UIKit
First of all, import the module `JustPhotoPicker` into a file with your view controller:
```swift
import JustPhotoPicker
```
### Configuration
You can change some visual and logical parameters using the `JustPhotoPickerConfiguration` structure. Set all the options you want and create a picker with configuration as a parameter:
```swift
var config = JustPhotoPickerConfiguration()
config.selectionLimit = 2
config.isSelectionRequired = true
// Configuration vibes...
let photoPicker = JustPhotoPicker(configuration: config)
```
### Processing the result
#### Using the delegate
To obtain the selected photos or the fact that the photos were not selected, the `JustPhotoPickerDelegate` protocol can be used.
1. Setup a delegate for your photo picker:
```swift
photoPicker.photoPickerDelegate = self
```
2. Make your view controller conform the delegate protocol and implement both required methods:
```swift
extension ViewController: JustPhotoPickerDelegate {
func didSelect(with photoPicker: JustPhotoPicker, images: [UIImage]) {
print("Selected \(image.count) images")
}
func didNotSelect(with photoPicker: JustPhotoPicker) {
print("Did not select any images")
}
}
```
#### Using the closure
You also can use `didFinishPicking` closure of `JustPhotoPicker` class to obtain the selected photos:
```swift
let photoPicker = JustPhotoPicker(configuration: config)
photoPicker.didFinishPicking = { images, canceled in
if canceled {
print("Did not select any images")
return
}
print("Selected \(images.count) images")
}
```
The closure takes two parameters. The first one is either a list of selected images or an empty list in case if a user did not select any. The second parameter is a boolean flag indicating whether a user canceled the selection.
### Display
When you are ready to start picking photos, display the picker in the standard way:
```swift
present(photoPicker, animated: true)
```
## Usage in SwiftUI
Recently we added SwiftUI support for JustPhotoPicker. All you need to do is to call `JustPhotoPickerView` in the same way in the body of your SwiftUI:
```swift
VStack {
Button("Select photo") {
showingPicker = true
}
}
.sheet(isPresented: $showingPicker) {
JustPhotoPickerView(configuration: pickerConfig)
.onFinish { images in
print("Selected \(images.count) images")
}
.onCancel {
print("Did not select any images")
}
}
```
Learn more [here](Example/JustPhotoPickerSwiftUI/JustPhotoPickerSwiftUI/ContentView.swift)
## Configuration properties
The following are some of the possible settings for the picker, which you can also find in the `JustPhotoPickerConfiguration` structure:
```swift
config.selectionLimit = 2
config.isSelectionRequired = true
config.showsBottomDescriptionLabel = true
config.portraitModeCellsInRow = 3
config.landscapeModeCellsInRow = 6
config.backgroundColor = .white
config.accentColor = .systemPink
config.albumThumbnailCornerRaduis = 5
config.photoCardCornerRaduis = 0
config.startsOnScreen = .photos
config.hidesEmptyAlbumLabel = true
config.showsPhotoPreview = true
config.allowsPhotoPreviewZoom = false
// Configuration vibes...
```
## Localization
JustPhotoPicker is now translated into the following languages:
- English (Base)
- German
- French
- Russian
- Italian
- Spanish
- Romanian
- Czech
- Polish
- Ukrainian
If you want to add or correct localization, you are welcome to [contribute](#contribution).
## Contribution
To contribute, use the follow "fork-and-pull" git workflow:
1. Fork the repository on github
2. Clone the project to your own machine
3. Commit changes to your own branch
4. Push your work back up to your fork
5. Submit a pull request so that I can review your changes
*NOTE: Be sure to merge the latest from "upstream" before making a pull request!*
## License
JustPhotoPicker is available under the MIT license. See the LICENSE file for more info.