uii

UIImageCropper

Simple Image cropper for UIImagePickerController with customisable aspect ratio. Made purely with Swift!

Showing:

Popularity

Downloads/wk

0

GitHub Stars

48

Maintenance

Last Commit

2yrs ago

Contributors

3

Package

Dependencies

0

License

MIT

Categories

Readme

UIImageCropper

Simple Image cropper for UIImagePickerController with customisable crop aspect ratio. Made purely with Swift 4!

Replaces the iOS "crop only to square" functionality. Easy few line setup with delegate method/s.

Requirements

  • iOS10+
  • Xcode 9.2+
  • Swift 4

Install

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

pod 'UIImageCropper'

(or add UIImageCropper folder to your project)

Usage

Import the pod

import UIImageCropper

Create instanses of UIImageCropper and UIImagePickerController (optional, if cropping existing UIImage)

UIImageCropper can take cropRatio as parameter. Default ratio is 1 (square).

let picker = UIImagePickerController()
let cropper = UIImageCropper(cropRatio: 2/3)

Setup UIImageCropper

cropper.picker = picker
cropper.delegate = self
//cropper.cropRatio = 2/3 //(can be set with variable, before cropper is presented, or in cropper init)
//cropper.cropButtonText = "Crop" // button labes can be localised/changed
//cropper.cancelButtonText = "Cancel"

If just cropping existing UIImage there is no need to set up picker, delegate is enough. Just give image to croppen and present it.

cropper.picker = nil // Make sure not set the picker when doing existing image cropping
cropper.image = UIImage(named: "image")
viewController.present(cropper, animated: true, completion: nil)

For both cases implement UIImageCropperProtocol delegate method/s

func didCropImage(originalImage: UIImage?, croppedImage: UIImage?) {
    imageView.image = croppedImage
}

//optional (if not implemented cropper will close itself and picker)
func didCancel() {
    picker.dismiss(animated: true, completion: nil)
}

The UIImageCropper will handle the image picking (delegate methods). To start image picking just present the UIImagePickerController instance.

self.present(self.picker, animated: true, completion: nil)

For full usage exmaple see CropperExample in Example folder.

Issues and contribution

If you find any issues please add and issue to this repository.

Improvements and/or fixes as pull requests are more than welcome.

Author

Jari Kalinainen, jari(a)klubitii.com

License

UIImageCropper is available under the MIT license. See the LICENSE file for more info.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100