Android Image Cropper

:triangular_flag_on_post: The Project is NOT currently maintained :triangular_flag_on_post:

Please use CanHub's fork!

Thank everybody for using the library. It was very fun to create and a privilage to help you build awesome apps.

The same way I took an unmaintained initial implementation from edmodo, I'm happy to see CanHub taking it now.

Good luck and happy coding :octocat:

Powerful (Zoom, Rotation, Multi-Source), customizable (Shape, Limits, Style), optimized (Async, Sampling, Matrix) and simple image cropping library for Android.

Usage

For a working implementation, please have a look at the Sample Project

See GitHub Wiki for more info.

1. Include the library

   dependencies {
    api 'com.theartofdev.edmodo:android-image-cropper:2.8.+'
   }

Add permissions to manifest

 <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
 <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>

Add this line to your Proguard config file

-keep class androidx.appcompat.widget.** { *; }

Using Activity

2. Add CropImageActivity into your AndroidManifest.xml

   <activity android:name="com.theartofdev.edmodo.cropper.CropImageActivity"
   android:theme="@style/Base.Theme.AppCompat"/> <!-- optional (needed if default theme has no action bar) -->

3. Start CropImageActivity using builder pattern from your activity

   // start picker to get image for cropping and then use the image in cropping activity
   CropImage.activity()
   .setGuidelines(CropImageView.Guidelines.ON)
   .start(this);
   
   // start cropping activity for pre-acquired image saved on the device
   CropImage.activity(imageUri)
   .start(this);
   
   // for fragment (DO NOT use `getActivity()`)
   CropImage.activity()
   .start(getContext(), this);

4. Override onActivityResult method in your activity to get crop result

   @Override
   public void onActivityResult(int requestCode, int resultCode, Intent data) {
   if (requestCode == CropImage.CROP_IMAGE_ACTIVITY_REQUEST_CODE) {
    CropImage.ActivityResult result = CropImage.getActivityResult(data);
    if (resultCode == RESULT_OK) {
      Uri resultUri = result.getUri();
    } else if (resultCode == CropImage.CROP_IMAGE_ACTIVITY_RESULT_ERROR_CODE) {
      Exception error = result.getError();
    }
   }
   }

Using View

2. Add CropImageView into your activity

   <!-- Image Cropper fill the remaining available height -->
   <com.theartofdev.edmodo.cropper.CropImageView
   xmlns:custom="http://schemas.android.com/apk/res-auto"
   android:id="@+id/cropImageView"
   android:layout_width="match_parent"
   android:layout_height="0dp"
   android:layout_weight="1"/>

3. Set image to crop

   cropImageView.setImageUriAsync(uri);
   // or (prefer using uri for performance and better user experience)
   cropImageView.setImageBitmap(bitmap);

4. Get cropped image

   // subscribe to async event using cropImageView.setOnCropImageCompleteListener(listener)
   cropImageView.getCroppedImageAsync();
   // or
   Bitmap cropped = cropImageView.getCroppedImage();

Features

• Built-in CropImageActivity.
• Set cropping image as Bitmap, Resource or Android URI (Gallery, Camera, Dropbox, etc.).
• Image rotation/flipping during cropping.
• Auto zoom-in/out to relevant cropping area.
• Auto rotate bitmap by image Exif data.
• Set result image min/max limits in pixels.
• Set initial crop window size/location.
• Request cropped image resize to specific size.
• Bitmap memory optimization, OOM handling (should never occur)!
• API Level 14.
• More..

Customizations

• Cropping window shape: Rectangular or Oval (cube/circle by fixing aspect ratio).
• Cropping window aspect ratio: Free, 1:1, 4:3, 16:9 or Custom.
• Guidelines appearance: Off / Always On / Show on Toch.
• Cropping window Border line, border corner and guidelines thickness and color.
• Cropping background color.

For more information, see the GitHub Wiki.

Posts

• Android cropping image from camera or gallery
• Android Image Cropper async support and custom progress UI
• Adding auto-zoom feature to Android-Image-Cropper

Change log

2.8.0

• Fix crash on Android O (thx @juliooa)
• Update to support library to AndroidX (thx @mradzinski)
• Handle failure when selecting non image file (thx @uncledoc)
• More translations (thx @jkwiecien, @david-serrano)

2.7.0

• Update gradle wrapper to 4.4
• Update support library to 27.1.1 and set is statically! (thx @androideveloper)
• Fix NPE in activity creation by tools (thx @unverbraucht)
• More translations (thx @gwharvey, @dlackty, @JairoGeek, @shaymargolis)

See full change log.

License

Originally forked from edmodo/cropper.

Copyright 2016, Arthur Teplitzki, 2013, Edmodo, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.