Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/drjacky/imagepicker
📸Image Picker for Android, Pick images from Gallery or Capture a new image with Camera🖼
https://github.com/drjacky/imagepicker
android android-library camera compress-image compress-images crop-image image image-picker image-picker-android image-resizer imagepicker imageresize kotlin kotlin-android
Last synced: 12 days ago
JSON representation
📸Image Picker for Android, Pick images from Gallery or Capture a new image with Camera🖼
- Host: GitHub
- URL: https://github.com/drjacky/imagepicker
- Owner: Drjacky
- License: apache-2.0
- Created: 2020-11-23T20:29:05.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-05-19T11:15:06.000Z (over 1 year ago)
- Last Synced: 2024-10-12T20:24:01.863Z (26 days ago)
- Topics: android, android-library, camera, compress-image, compress-images, crop-image, image, image-picker, image-picker-android, image-resizer, imagepicker, imageresize, kotlin, kotlin-android
- Language: Kotlin
- Homepage: https://github.com/Drjacky/ImagePicker
- Size: 31.7 MB
- Stars: 232
- Watchers: 3
- Forks: 57
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 📸Image Picker Library for Android
[](https://github.com/drjacky/ImagePicker/releases)
[](https://android-arsenal.com/api?level=19)
[](https://github.com/Drjacky/ImagePicker/pulls)
[](https://app.fossa.com/projects/git%2Bgithub.com%2FDrjacky%2FImagePicker?ref=badge_shield)
[](https://android-arsenal.com/details/1/8208)
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 Images
* Pick Images from Google Drive
* Capture Camera Image
* Crop Images(Crop image based on provided aspect ratio or let user choose one)
* Compress Images(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:
```groovy
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
}
}
```
```groovy
implementation 'com.github.Drjacky:ImagePicker:$libVersion'
```
Where `$libVersion`
= [](https://github.com/drjacky/ImagePicker/releases)
## 🎨Customization
**If you want to get the activity result:**
**Kotlin**
```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
// Only if you are not using crop feature:
uri?.let { galleryUri ->
contentResolver.takePersistableUriPermission(
uri, Intent.FLAG_GRANT_READ_URI_PERMISSION
)
}
//////////////
}
}
```
**Java**
```java
ActivityResultLauncher 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
}
});
```
**Both Camera and Gallery:**
```kotlin
ImagePicker.with(this)
//...
.provider(ImageProvider.BOTH) //Or bothCameraGallery()
.createIntentFromDialog { launcher.launch(it) }
```
**Crop image:**
```kotlin
.crop()
```
**Crop image with 16:9 aspect ratio:**
```kotlin
.crop(16f, 9f)
```
**Crop square image(e.g for profile):**
```kotlin
.cropSquare() //Crop square image, its same as crop(1f, 1f)
```
**Oval crop image:**
```kotlin
.crop()
.cropOval() //Allow dimmed layer to have a circle inside
```
**Set Max Width and Height of final image:**
```kotlin
.maxResultSize(512, 512, true) //true: Keep Ratio
```
**Java sample for using `createIntentFromDialog`:**
```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(camera or gallery):**
```kotlin
launcher.launch(
ImagePicker.with(this)
//...
.cameraOnly() // or galleryOnly()
.createIntent()
)
```
**Let the user to resize crop bounds:**
```kotlin
.crop()
.cropFreeStyle()
```
**Let the user to pick multiple files or single file in gallery mode:**
```kotlin
.setMultipleAllowed(true)
```
**Let the user defines the output format:**
```kotlin
.setOutputFormat(Bitmap.CompressFormat.WEBP)
```
**Intercept ImageProvider; could be used for analytics purposes:**
```kotlin
ImagePicker.with(this)
.setImageProviderInterceptor { imageProvider -> //Intercept ImageProvider
Log.d("ImagePicker", "Selected ImageProvider: "+imageProvider.name)
}
.createIntent()
```
**Intercept Dialog dismiss event:**
```kotlin
ImagePicker.with(this)
.setDismissListener {
// Handle dismiss event
Log.d("ImagePicker", "onDismiss");
}
.createIntent()
```
**Limit MIME types while choosing a gallery image:**
```kotlin
.galleryMimeTypes( //Exclude gif images
mimeTypes = arrayOf(
"image/png",
"image/jpg",
"image/jpeg"
)
)
```
**Add Following parameters in your **colors.xml** file, if you want to customize uCrop Activity:**
```xml
@color/teal_500
@color/teal_700
@color/teal_500
```
## 💥Compatibility
* Library - Android Kitkat 4.4+ (API 19)
* Sample - Android Kitkat 4.4+ (API 19)
## 📃 Libraries Used
* uCrop [https://github.com/Yalantis/uCrop](https://github.com/Yalantis/uCrop)
* Compressor [https://github.com/zetbaitsu/Compressor](https://github.com/zetbaitsu/Compressor)
* ImagePicker [https://github.com/Dhaval2404/ImagePicker](https://github.com/Dhaval2404/ImagePicker) which my work is based on this repository.
## License
[](https://app.fossa.com/projects/git%2Bgithub.com%2FDrjacky%2FImagePicker?ref=badge_large)