Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/congnd/FMPhotoPicker
A modern, simple and zero-dependency photo picker with an elegant and customizable image editor
https://github.com/congnd/FMPhotoPicker
crop effects filter image image-editor image-procesing ios photopicker photos picker swift video
Last synced: 10 days ago
JSON representation
A modern, simple and zero-dependency photo picker with an elegant and customizable image editor
- Host: GitHub
- URL: https://github.com/congnd/FMPhotoPicker
- Owner: congnd
- License: mit
- Created: 2018-02-06T03:47:25.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-06-27T16:29:30.000Z (over 1 year ago)
- Last Synced: 2024-10-25T16:44:05.799Z (14 days ago)
- Topics: crop, effects, filter, image, image-editor, image-procesing, ios, photopicker, photos, picker, swift, video
- Language: Swift
- Homepage:
- Size: 3.91 MB
- Stars: 769
- Watchers: 26
- Forks: 128
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- fucking-awesome-swift - FMPhotoPicker - A modern, simple and zero-dependency photo picker with an elegant and customizable image editor. (Libs / Images)
- awesome-swift - FMPhotoPicker - A modern, simple and zero-dependency photo picker with an elegant and customizable image editor ` 📝 6 months ago ` (Images [🔝](#readme))
- awesome-swift - FMPhotoPicker - A modern, simple and zero-dependency photo picker with an elegant and customizable image editor. (Libs / Images)
README
[](/LICENSE)
[](https://github.com/Carthage/Carthage)
[](https://cocoapods.org/pods/FMPhotoPicker)
[](https://github.com/congnd/FMPhotoPicker/actions)
FMPhotoPicker is a modern, simple and zero-dependency photo picker with an elegant and customizable image editor
## Quick demo
|
Batch select/deselect|Smooth transitions|Filter|Crop|
|---|---|---|---|
|| |||
## Features
- [x] Support both single and multiple selection
- [x] Support batch selection/deselection by swipe gesture
- [x] Support preview
- [x] Support simple image editor with filter and cropping functions
- [x] Support force crop mode
- [x] Support rounded image preview
- [x] Support adding self-define cropping
- [x] Support adding self-define filter
- [x] Support video player
- [x] Support custom confirmation view
- [x] Support language customization
## Requirements
- iOS 9.0+
## Installation
### SwiftPM
```
dependencies: [
.package(url: "https://github.com/congnd/FMPhotoPicker.git", .exact("1.3.0")),
]
```
### Carthage
Insert the following line in your Carthfile:
```
git "[email protected]:congnd/FMPhotoPicker.git"
```
and run `carthage update FMPhotoPicker`
### CocoaPods
FMPhotoPicker is now available in [CocoaPods](https://cocoapods.org/pods/FMPhotoPicker)
You want to add pod 'FMPhotoPicker', '~> 1.3.0' similar to the following to your Podfile:
```
target 'MyApp' do
pod 'FMPhotoPicker', '~> 1.3.0'
end
```
Then run a `pod install` inside your terminal.
## Usage
#### Create a configuration object
```swift
var config = FMPhotoPickerConfig()
```
For details, see [Configuration](#configuration)
### Picker
```swift
let picker = FMPhotoPickerViewController(config: config)
picker.delegate = self
self.present(picker, animated: true)
```
*From iOS 10, you have to add the `Privacy - Photo Library Usage Description` into your Info.plist file.*
### Editor
```swift
let editor = FMImageEditorViewController(config: config, sourceImage: image)
editor.delegate = self
self.present(editor, animated: true)
```
## Delegation methods
- Implement FMPhotoPickerViewControllerDelegate protocol to handle selected photos.
```swift
func fmPhotoPickerController(_ picker: FMPhotoPickerViewController, didFinishPickingPhotoWith photos: [UIImage])
func fmPhotoPickerController(_ picker: FMPhotoPickerViewController, didFinishPickingPhotoWith assets: [PHAsset])
```
***If you prefer to receive selected photos in type of `PHAsset` instead of `UIImage` then don't forget to set the `shouldReturnAsset` to `true` and implement the corresponding delegation method.***
- Implement FMImageEditorViewControllerDelegate protocol to handle ouput image
```swift
func fmImageEditorViewController(_ editor: FMImageEditorViewController, didFinishEdittingPhotoWith photo: UIImage)
```
## Configuration
#### The configuration supports the following parameters:
- [`mediaTypes`](#ref-media-types)
- [`selectMode`](#ref-select-mode)
- [`maxImage`](#ref-max-image)
- [`maxVideo`](#ref-max-video)
- [`availableFilters`](#ref-available-filters)
- [`availableCrops`](#ref-available-crops)
- [`useCropFirst`](#ref-use-crop-first)
- [`alertController`](#ref-alert-controller)
- [`shouldReturnAsset`](#ref-should-return-asset)
- [`forceCropEnabled`](#ref-force-crop-enabled)
- [`eclipsePreviewEnabled`](#ref-eclipse-preview-enabled)
- [`strings`](#ref-strings)
#### Reference
- `mediaTypes`
An array that indicates the media types to be accessed by the picker controller.
Type: `[FMMediaType]`
Default: `[.image, .video]`
- `selectMode`
Photo selection mode that can be in `single` or `multiple` mode.
Type: : `FMSelectMode`
Default is `multiple`
- `maxImage`
The maximum number of images can be selected.
Type: `Int`
Default: `10`
- `maxVideo`
The maximum number of videos can be selected.
Type: `Int`
Default is `10`
- `availableFilters`
Filter options that are used in editor. **Set this parameter to `nil` to make the filter menu be unavailable in the editor**
FMPhotoEditor provides some default filters that will be fit to you.
Type: `[FMFilterable]?`
Default: all filters are provided by FMPhotoPicker.
- `availableCrops`
Crop options that is used in editor. **Set this parameter to `nil` to make the cropping menu be unavailable in the editor**
FMPhotoEditor provides some default crops that will be fit to you.
Type: `[FMCroppable]?`
Default: all crops provided by FMPhotoPicker.
***You are not allowed to use the editor without giving it at least one crop option or one filter option***
- `useCropFirst`
An option that indicates whether the crop menu should be selected by default in the `FMImageEditorViewController`.
Type: `Bool`
Default: `false`
- `alertController`
An alert controller to show the confirmation view to an user with 2 options: Ok or Cancel.
Type: `FMAlertable`
Default: `FMAlert`
- `shouldReturnAsset`
Whether you want FMPhotoPicker returns PHAsset instead of UIImage.
***FMPhotoPicker chooses a proper delegation method to be invoked when user finishes picking based on this configuration***
Type: `Bool`
Default: `false`
- `forceCropEnabled`
A bool value that indicates whether force mode is enabled.
If `true` is set, only the first crop in the `availableCrops` is used in the editor.
And that crop's ration becomes force crop ratio.
Type: `FMAlertable`
Default: `false`
- `eclipsePreviewEnabled`
A bool value that indicates whether the preview of image should be displayed in rounded image.
Type: `Bool`
Default: `false`
- `strings`
A dictionary that allows you to customize language for your app.
For details, see `FMPhotoPickerConfig.swift`
Type: `Dictionary`
## Customization
### Custom filter
You can freely create your own filter by implementing the `FMFilterable` protocol.
```swift
public protocol FMFilterable {
func filter(image: UIImage) -> UIImage
func filterName() -> String
}
```
Be careful that the filterName is used to determine whether the two filters are the same.
Make sure that your filter's names are not duplicated, especially with the default filters that you want to use.
### Custom cropping
Similar as filter function, FMPhotoPicker provides the capability to use your own cropping by implementing the `FMCroppable` protocol.
```swift
public protocol FMCroppable {
func crop(image: UIImage, toRect rect: CGRect) -> UIImage
func name(string: [String: String]) -> String
func icon() -> UIImage
func ratio() -> FMCropRatio?
}
```
The `func name(strings: [String: String]) -> String` will receive the strings configuration from configuration object.
It allows you customize the cropping while keeping all your language setting in only one place.
The `name()` method is also used as identifier for the cropping.
Thus, make sure you do not have any duplicate of the cropping name.
### Custom alert view controller
You can use your own view style for the confirmation view by implementing the `FMAlertable` protocol.
```swift
public protocol FMAlertable {
func show(in viewController: UIViewController, ok: @escaping () -> Void, cancel: @escaping () -> Void)
}
```
## Contact
Follow and contact me on [Twitter](https://twitter.com/congndcom).
If you find an issue, just [open a ticket](https://github.com/congnd/FMPhotoPicker/issues/new).
Pull requests are warmly welcome as well.
## License
FMPhotoPicker is released under the MIT license. See LICENSE for details.