ImagePicker
ImagePicker copied to clipboard
📸Image Picker for Android, Pick images from Gallery or Capture a new image with Camera🖼
📸Image Picker Library for Android
Easy to use and configurable library to Pick an image from the Gallery or Capture image using Camera. It also allows to Crop the Image based on Aspect Ratio, Resolution and Image Size.
🏍Features
- Pick Gallery Image
- Pick Image from Google Drive
- Capture Camera Image
- Crop Image(Crop image based on provided aspect ratio or let user choose one)
- Compress Image(Compress image based on provided resolution and size)
- Retrieve Image Result as File, File Path as String or Uri object
- Handle Runtime Permission for Camera and Storage
🎬Preview
Profile Image Picker | Gallery Only | Camera Only |
---|---|---|
![]() |
![]() |
![]() |
💻Usage
Gradle dependency:
allprojects {
repositories {
mavenCentral() // For ImagePicker library, this line is enough. Although, it has been published on jitpack as well
maven { url "https://jitpack.io" } //Make sure to add this in your project for uCrop - an internal library
}
}
implementation 'com.github.Drjacky:ImagePicker:$libVersion'
If you want to get the activity result:
Kotlin
private val launcher = registerForActivityResult(ActivityResultContracts.StartActivityForResult()) {
if (it.resultCode == Activity.RESULT_OK) {
val uri = it.data?.data!!
// Use the uri to load the image
}
}
Java
ActivityResultLauncher<Intent> launcher =
registerForActivityResult(new ActivityResultContracts.StartActivityForResult(), (ActivityResult result) -> {
if (result.getResultCode() == RESULT_OK) {
Uri uri = result.getData().getData();
// Use the uri to load the image
} else if (result.getResultCode() == ImagePicker.RESULT_ERROR) {
// Use ImagePicker.Companion.getError(result.getData()) to show an error
}
});
If you want both Camera and Gallery:
Kotlin
ImagePicker.with(this)
//...
.provider(ImageProvider.BOTH) //Or bothCameraGallery()
.createIntentFromDialog { launcher.launch(it) }
Java
ImagePicker.Companion.with(this)
.crop()
.cropOval()
.maxResultSize(512,512,true)
.provider(ImageProvider.BOTH) //Or bothCameraGallery()
.createIntentFromDialog((Function1)(new Function1(){
public Object invoke(Object var1) {
this.invoke((Intent) var1);
return Unit.INSTANCE;
}
public final void invoke(@NotNull Intent it) {
Intrinsics.checkNotNullParameter(it, "it");
launcher.launch(it);
}
}));
If you want just one option:
Kotlin
launcher.launch(
ImagePicker.with(this)
//...
.cameraOnly() // or galleryOnly()
.createIntent()
)
Java
ImagePicker.Companion.with(this)
.crop() //Crop image(Optional), Check Customization for more option
.cropOval() //Allow dimmed layer to have a circle inside
.cropFreeStyle() //Let the user to resize crop bounds
.galleryOnly() //We have to define what image provider we want to use
.maxResultSize(1080, 1080) //Final image resolution will be less than 1080 x 1080(Optional)
.createIntent()
🎨Customization
-
Pick image using Gallery
ImagePicker.with(this) .galleryOnly() //User can only select image from Gallery .createIntent() //Default Request Code is ImagePicker.REQUEST_CODE
-
Capture image using Camera
ImagePicker.with(this) .cameraOnly() //User can only capture image using Camera .createIntent()
-
Crop image
ImagePicker.with(this) .crop() //Crop image and let user choose aspect ratio. .createIntent()
-
Crop image with fixed Aspect Ratio
ImagePicker.with(this) .crop(16f, 9f) //Crop image with 16:9 aspect ratio .createIntent()
-
Crop square image(e.g for profile)
ImagePicker.with(this) .cropSquare() //Crop square image, its same as crop(1f, 1f) .createIntent()
-
Compress image size(e.g image should be maximum 1 MB)
ImagePicker.with(this) .createIntent()
-
Set Resize image resolution
ImagePicker.with(this) .maxResultSize(620, 620) //Final image resolution will be less than 620 x 620 .createIntent()
-
Intercept ImageProvider, Can be used for analytics
ImagePicker.with(this) .setImageProviderInterceptor { imageProvider -> //Intercept ImageProvider Log.d("ImagePicker", "Selected ImageProvider: "+imageProvider.name) } .createIntent()
-
Intercept Dialog dismiss event
ImagePicker.with(this) .setDismissListener { // Handle dismiss event Log.d("ImagePicker", "onDismiss"); } .createIntent()
-
Limit MIME types while choosing a gallery image
ImagePicker.with(this) .galleryMimeTypes( //Exclude gif images mimeTypes = arrayOf( "image/png", "image/jpg", "image/jpeg" ) ) .createIntent()
-
Add Following parameters in your colors.xml file, If you want to customize uCrop Activity.
<resources> <!-- Here you can add color of your choice --> <color name="ucrop_color_toolbar">@color/teal_500</color> <color name="ucrop_color_statusbar">@color/teal_700</color> <color name="ucrop_color_widget_active">@color/teal_500</color> </resources>
💥Compatibility
- Library - Android Kitkat 4.4+ (API 19)
- Sample - Android Kitkat 4.4+ (API 19)
📃 Libraries Used
- uCrop https://github.com/Yalantis/uCrop
- Compressor https://github.com/zetbaitsu/Compressor
- ImagePicker https://github.com/Dhaval2404/ImagePicker which my work is based on this repository.