Skip to content

Latest commit

 

History

History
135 lines (110 loc) · 4.65 KB

README.md

File metadata and controls

135 lines (110 loc) · 4.65 KB
Raw

CanHub

☕Using the library in Java

❓FAQ - frequently asked question

Android Image Cropper

  • Powerful (Zoom, Rotation, Multi-Source);
  • Customizable (Shape, Limits, Style);
  • Optimized (Async, Sampling, Matrix);
  • Simple image cropping library for Android.

Features List

Crop

Add to your project

Step 1. Add the JitPack repository to your root build.gradle

  allprojects {
     repositories {
       ....
       maven { url 'https://jitpack.io' }
     }
  }

Step 2. Add the dependency

  dependencies {
       implementation 'com.github.CanHub:Android-Image-Cropper:${version}'
  }

Latest Release Version

Step 3. Add permissions to manifest

Only need if you run on devices under OS10 (SDK 29)

<manifest>
   <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"
       android:maxSdkVersion="28" />
</manifest>

Step 4. Set source compatibility version to Java 11

  • The library is up to date with the latest releases, if you are not using Java 11 yet please check the release page for previous working versions.
  • Go to app level build.gradle file
  • Add this line inside android in build.gradle 
     compileOptions {
     sourceCompatibility JavaVersion.VERSION_11
     targetCompatibility JavaVersion.VERSION_11
 }

 kotlinOptions {
     jvmTarget = JavaVersion.VERSION_11.toString()
 }
  • This expects Gradle 7.0+

Using the Library

There is 3 ways of using the library:

Your choice depends on how you want your layout to look.

Calling crop directly

Sample code

  • Register for activity result with CropImageContract
class MainActivity {
   private val cropImage = registerForActivityResult(CropImageContract()) { result ->
           if (result.isSuccessful) {
               // use the returned uri
               val uriContent = result.uriContent 
               val uriFilePath = result.getUriFilePath(context) // optional usage
           } else {
               // an error occurred
               val exception = result.error
           }
       }

   private fun startCrop() {
       // start picker to get image for cropping and then use the image in cropping activity
       cropImage.launch(
           options {
               setGuidelines(Guidelines.ON)
           }
       )

       //start picker to get image for cropping from only gallery and then use the image in
       //cropping activity
       cropImage.launch(
           options {
               setImagePickerContractOptions(
                   PickImageContractOptions(includeGallery = true, includeCamera = false)
               )
           }
       )

       // start cropping activity for pre-acquired image saved on the device and customize settings
       cropImage.launch(
           options(uri = imageUri) {
               setGuidelines(Guidelines.ON)
               setOutputCompressFormat(CompressFormat.PNG)
           }
       )
   }
}

Posts

Wanna help the project? Amazing!

License

Forked from ArthurHub 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.