Android Image Cropper

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.

Include the library

compile 'com.theartofdev.edmodo:android-image-cropper:2.3.+'

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

CropImage.activity(imageUri)
   .setGuidelines(CropImageView.Guidelines.ON)
   .start(this);

// for fragment (DO NOT use `getActivity()`)
CropImage.activity(imageUri)
    .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.setImageBitmap(bitmap);
// or
cropImageView.setImageUriAsync(uri);

4. Get cropped image

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

Features

• Built-in CropImageActivity.
• Set cropping image as Bitmap, Resource or Android URI (Gallery, Camera, Dropbox, etc.).
• Image rotation 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 10.
• 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.3.1

• Fix image picker for xiaomi and huawei phones (thx @nicolabeghin)
• Fix crop window get corrupted on CropImageView resize.

2.3.0

• Change required width/height behavior to support resizing (inside/fit/exact) see wiki for details.
• Add sampling fallback to lower cropped image resolution on OOM error (if image loaded from URI).
• Setting aspect ratio will also set it to fixed, to help with confusion, add clear aspect ratio method.
• Add support for setting min/max crop result size in code on CropImageView.
• Fix cropping failing bug when skia fails region cropping.
• Add Fallback to Intent.ACTION_PICK if no intent found for Intent.ACTION_GET_CONTENT (thx geolyth)
• Multi touch support for cropping window (experimental, thx bbwharris)
• BREAKING CHANGES:
• If you previously used requested width/height the default behavior now is to resize inside the cropped image, to preserve the previous behavior you need to pass the SAMPLING option.
• OnGetCroppedImageCompleteListener and OnSaveCroppedImageCompleteListener is deprecated, use OnCropImageCompleteListener that combines the two and provides the result object as crop activity.
• Set aspect ratio also sets fixed aspect ratio to true, if this is not the desired behavior set the fix aspect ratio flag manually or call the method after calling set aspect ratio.

2.2.5

• Fix to webp file extension (thx Nathan)
• Fix wrong initial crop window when image contains exif data.
• Added corners to circular crop window, can be removed by setting BorderCornerThickness to 0.

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.