Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Dhaval2404/ImagePicker
📸Image Picker for Android, Pick an image from Gallery or Capture a new image with Camera
https://github.com/Dhaval2404/ImagePicker
android android-library camera compress-images crop-image image image-picker image-provider imagepicker imageresize kotlin
Last synced: 13 days ago
JSON representation
📸Image Picker for Android, Pick an image from Gallery or Capture a new image with Camera
- Host: GitHub
- URL: https://github.com/Dhaval2404/ImagePicker
- Owner: Dhaval2404
- License: apache-2.0
- Created: 2018-12-04T01:51:50.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-10-22T09:30:15.000Z (about 1 year ago)
- Last Synced: 2024-10-22T16:16:56.999Z (17 days ago)
- Topics: android, android-library, camera, compress-images, crop-image, image, image-picker, image-provider, imagepicker, imageresize, kotlin
- Language: Kotlin
- Homepage:
- Size: 15.3 MB
- Stars: 1,529
- Watchers: 25
- Forks: 341
- Open Issues: 118
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-kotlin - ImagePicker - 📸Image Picker for Android, Pick an image from Gallery or Capture a new image with Camera (Libraries)
README
# 📸Image Picker Library for Android
[](https://jitpack.io/#Dhaval2404/ImagePicker)
[](https://github.com/Dhaval2404/ImagePicker/releases)
[](https://android-arsenal.com/api?level=19)
[]( https://android-arsenal.com/details/1/7510 )
[](https://ktlint.github.io/)
[](https://github.com/Dhaval2404/ImagePicker)
[](https://opensource.org/licenses/Apache-2.0)
[](https://github.com/Dhaval2404/ImagePicker/blob/master/LICENSE)
[](https://twitter.com/intent/tweet?text=Check+out+an+ImagePicker+library+to+Pick+an+image+from+the+Gallery+or+Capture+an+image+with+Camera.+https%3A%2F%2Fgithub.com%2FDhaval2404%2FImagePicker+%40dhaval2404+%23Android+%23Kotlin+%23AndroidDev)
Easy to use and configurable library to **Pick an image from the Gallery or Capture image using Camera**. It also allows to **Crop and Compresses the Image based on Aspect Ratio, Resolution and Image Size**.
Almost 90% of the app that I have developed has an Image upload feature. Along with the image selection, Sometimes I needed a crop feature for profile image for that I've used uCrop. Most of the time I need to compress the image as the image captured from the camera is more than 5-10 MBs and sometimes we have a requirement to upload images with specific resolution/size, in that case, image compress is the way to go option. To simplify the image pick/capture option I have created ImagePicker library. I hope it will be useful to all.
# 🐱🏍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 Uri object (Retrieve as File object feature is removed in v2.0 to support scope storage)
* Handle runtime permission for camera
* Does not require storage permission to pick gallery image or capture new image.
# 🎬Preview
Profile Image Picker | Gallery Only | Camera Only |
:-------------------------:|:-------------------------:|:-------------------------:
 |  | 
# 💻Usage
1. Gradle dependency:
```groovy
allprojects {
repositories {
maven { url "https://jitpack.io" }
}
}
```
```groovy
implementation 'com.github.dhaval2404:imagepicker:2.1'
```
**If you are yet to Migrate on AndroidX, Use support build artifact:**
```groovy
implementation 'com.github.dhaval2404:imagepicker-support:1.7.1'
```
2. The ImagePicker configuration is created using the builder pattern.
**Kotlin**
```kotlin
ImagePicker.with(this)
.crop() //Crop image(Optional), Check Customization for more option
.compress(1024) //Final image size will be less than 1 MB(Optional)
.maxResultSize(1080, 1080) //Final image resolution will be less than 1080 x 1080(Optional)
.start()
```
**Java**
```kotlin
ImagePicker.with(this)
.crop() //Crop image(Optional), Check Customization for more option
.compress(1024) //Final image size will be less than 1 MB(Optional)
.maxResultSize(1080, 1080) //Final image resolution will be less than 1080 x 1080(Optional)
.start()
```
3. Handling results
**Override `onActivityResult` method and handle ImagePicker result.**
```kotlin
override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
super.onActivityResult(requestCode, resultCode, data)
if (resultCode == Activity.RESULT_OK) {
//Image Uri will not be null for RESULT_OK
val uri: Uri = data?.data!!
// Use Uri object instead of File to avoid storage permissions
imgProfile.setImageURI(fileUri)
} else if (resultCode == ImagePicker.RESULT_ERROR) {
Toast.makeText(this, ImagePicker.getError(data), Toast.LENGTH_SHORT).show()
} else {
Toast.makeText(this, "Task Cancelled", Toast.LENGTH_SHORT).show()
}
}
```
**Inline method (with registerForActivityResult, Only Works with FragmentActivity and AppCompatActivity)**
i. Add required dependency for registerForActivityResult API
```groovy
implementation "androidx.activity:activity-ktx:1.2.3"
implementation "androidx.fragment:fragment-ktx:1.3.3"
```
ii. Declare this method inside fragment or activity class
```kotlin
private val startForProfileImageResult =
registerForActivityResult(ActivityResultContracts.StartActivityForResult()) { result: ActivityResult ->
val resultCode = result.resultCode
val data = result.data
if (resultCode == Activity.RESULT_OK) {
//Image Uri will not be null for RESULT_OK
val fileUri = data?.data!!
mProfileUri = fileUri
imgProfile.setImageURI(fileUri)
} else if (resultCode == ImagePicker.RESULT_ERROR) {
Toast.makeText(this, ImagePicker.getError(data), Toast.LENGTH_SHORT).show()
} else {
Toast.makeText(this, "Task Cancelled", Toast.LENGTH_SHORT).show()
}
}
```
iii. Create ImagePicker instance and launch intent
```kotlin
ImagePicker.with(this)
.compress(1024) //Final image size will be less than 1 MB(Optional)
.maxResultSize(1080, 1080) //Final image resolution will be less than 1080 x 1080(Optional)
.createIntent { intent ->
startForProfileImageResult.launch(intent)
}
```
# 🎨Customization
* Pick image using Gallery
```kotlin
ImagePicker.with(this)
.galleryOnly() //User can only select image from Gallery
.start() //Default Request Code is ImagePicker.REQUEST_CODE
```
* Capture image using Camera
```kotlin
ImagePicker.with(this)
.cameraOnly() //User can only capture image using Camera
.start()
```
* Crop image
```kotlin
ImagePicker.with(this)
.crop() //Crop image and let user choose aspect ratio.
.start()
```
* Crop image with fixed Aspect Ratio
```kotlin
ImagePicker.with(this)
.crop(16f, 9f) //Crop image with 16:9 aspect ratio
.start()
```
* Crop square image(e.g for profile)
```kotlin
ImagePicker.with(this)
.cropSquare() //Crop square image, its same as crop(1f, 1f)
.start()
```
* Compress image size(e.g image should be maximum 1 MB)
```kotlin
ImagePicker.with(this)
.compress(1024) //Final image size will be less than 1 MB
.start()
```
* Set Resize image resolution
```kotlin
ImagePicker.with(this)
.maxResultSize(620, 620) //Final image resolution will be less than 620 x 620
.start()
```
* Intercept ImageProvider, Can be used for analytics
```kotlin
ImagePicker.with(this)
.setImageProviderInterceptor { imageProvider -> //Intercept ImageProvider
Log.d("ImagePicker", "Selected ImageProvider: "+imageProvider.name)
}
.start()
```
* Intercept Dialog dismiss event
```kotlin
ImagePicker.with(this)
.setDismissListener {
// Handle dismiss event
Log.d("ImagePicker", "onDismiss");
}
.start()
```
* Specify Directory to store captured, cropped or compressed images. *Do not use external public storage directory (i.e. Environment.getExternalStorageDirectory())*
```kotlin
ImagePicker.with(this)
/// Provide directory path to save images, Added example saveDir method. You can choose directory as per your need.
// Path: /storage/sdcard0/Android/data/package/files
.saveDir(getExternalFilesDir(null)!!)
// Path: /storage/sdcard0/Android/data/package/files/DCIM
.saveDir(getExternalFilesDir(Environment.DIRECTORY_DCIM)!!)
// Path: /storage/sdcard0/Android/data/package/files/Download
.saveDir(getExternalFilesDir(Environment.DIRECTORY_DOWNLOADS)!!)
// Path: /storage/sdcard0/Android/data/package/files/Pictures
.saveDir(getExternalFilesDir(Environment.DIRECTORY_PICTURES)!!)
// Path: /storage/sdcard0/Android/data/package/files/Pictures/ImagePicker
.saveDir(File(getExternalFilesDir(Environment.DIRECTORY_PICTURES)!!, "ImagePicker"))
// Path: /storage/sdcard0/Android/data/package/files/ImagePicker
.saveDir(getExternalFilesDir("ImagePicker")!!)
// Path: /storage/sdcard0/Android/data/package/cache/ImagePicker
.saveDir(File(getExternalCacheDir(), "ImagePicker"))
// Path: /data/data/package/cache/ImagePicker
.saveDir(File(getCacheDir(), "ImagePicker"))
// Path: /data/data/package/files/ImagePicker
.saveDir(File(getFilesDir(), "ImagePicker"))
// Below saveDir path will not work, So do not use it
// Path: /storage/sdcard0/DCIM
// .saveDir(Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_DCIM))
// Path: /storage/sdcard0/Pictures
// .saveDir(Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_PICTURES))
// Path: /storage/sdcard0/ImagePicker
// .saveDir(File(Environment.getExternalStorageDirectory(), "ImagePicker"))
.start()
```
* Limit MIME types while choosing a gallery image
```kotlin
ImagePicker.with(this)
.galleryMimeTypes( //Exclude gif images
mimeTypes = arrayOf(
"image/png",
"image/jpg",
"image/jpeg"
)
)
.start()
```
* You can also specify the request code with ImagePicker
```kotlin
ImagePicker.with(this)
.maxResultSize(620, 620)
.start(101) //Here 101 is request code, you may use this in onActivityResult
```
* 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)
# ✔️Changelog
### Version: 2.1
* Added uzbekistan translation (Special Thanks to Khudoyshukur Juraev)
* Removed requestLegacyExternalStorage flag
* Removed unused string resources
### Version: 2.0
* Added arabic translation [#157](https://github.com/Dhaval2404/ImagePicker/pull/157) (Special Thanks to [zhangzhu95](https://github.com/zhangzhu95))
* Added norwegian translation [#163](https://github.com/Dhaval2404/ImagePicker/pull/163) (Special Thanks to [TorkelV](https://github.com/TorkelV))
* Added german translation [#192](https://github.com/Dhaval2404/ImagePicker/pull/192) (Special Thanks to [MDXDave](https://github.com/MDXDave))
* Added method to return Intent for manual launching ImagePicker [#182](https://github.com/Dhaval2404/ImagePicker/pull/182) (Special Thanks to [tobiasKaminsky](https://github.com/tobiasKaminsky))
* Added support for android 11 [#199](https://github.com/Dhaval2404/ImagePicker/issues/199)
* Fixed android scope storage issue [#29](https://github.com/Dhaval2404/ImagePicker/issues/29)
* Removed storage permissions [#29](https://github.com/Dhaval2404/ImagePicker/issues/29)
* Fixed calculateInSampleSize leads to overly degraded quality [#152](https://github.com/Dhaval2404/ImagePicker/issues/152) (Special Thanks to [FlorianDenis](https://github.com/FlorianDenis))
* Fixed camera app not found issue [#162](https://github.com/Dhaval2404/ImagePicker/issues/162)
* Fixed Playstore requestLegacyExternalStorage flag issue [#199](https://github.com/Dhaval2404/ImagePicker/issues/199)
### Version: 1.8
* Added dialog dismiss listener (Special Thanks to [kibotu](https://github.com/kibotu))
* Added text localization (Special Thanks to [yamin8000](https://github.com/yamin8000) and Jose Bravo)
* Fixed crash issue on missing camera app [#69](https://github.com/Dhaval2404/ImagePicker/issues/69)
* Fixed issue selecting images from download folder [#86](https://github.com/Dhaval2404/ImagePicker/issues/86)
* Fixed exif information lost issue [#121](https://github.com/Dhaval2404/ImagePicker/issues/121)
* Fixed crash issue on large image crop [#122](https://github.com/Dhaval2404/ImagePicker/issues/122)
* Fixed saving image in cache issue [#127](https://github.com/Dhaval2404/ImagePicker/issues/127)
### Version: 1.7
* Added option to limit MIME types while choosing a gallery image (Special Thanks to [Marchuck](https://github.com/Marchuck))
* Introduced ImageProviderInterceptor, Can be used for analytics (Special Thanks to [Marchuck](https://github.com/Marchuck))
* Fixed .crop() opening gallery or camera twice [#32](https://github.com/Dhaval2404/ImagePicker/issues/32)
* Fixed FileProvider of the library clashes with the FileProvider of the app [#51](https://github.com/Dhaval2404/ImagePicker/issues/51) (Special Thanks to [OyaCanli](https://github.com/OyaCanli))
* Added option to set Storage Directory [#52](https://github.com/Dhaval2404/ImagePicker/issues/52)
* Fixed NullPointerException in FileUriUtils.getPathFromRemoteUri() [#61](https://github.com/Dhaval2404/ImagePicker/issues/61) (Special Thanks to [himphen](https://github.com/himphen))
* Fixed UCropActivity Crash Android 4.4 (KiKat) [#82](https://github.com/Dhaval2404/ImagePicker/issues/82)
* Fixed PNG image saved as JPG after crop issue [#94](https://github.com/Dhaval2404/ImagePicker/issues/94)
* Fixed PNG image saved as JPG after compress issue [#105](https://github.com/Dhaval2404/ImagePicker/issues/105)
* Added Polish text translation [#115](https://github.com/Dhaval2404/ImagePicker/issues/115) (Special Thanks to [MarcelKijanka](https://github.com/MarcelKijanka))
* Failed to find configured root exception [#116](https://github.com/Dhaval2404/ImagePicker/issues/116)
### Version: 1.6
* Improved UI/UX of sample app
* Removed Bitmap Deprecated Property [#33](https://github.com/Dhaval2404/ImagePicker/issues/33) (Special Thanks to [nauhalf](https://github.com/nauhalf))
* Camera opens twice when "Don't keep activities" option is ON [#41](https://github.com/Dhaval2404/ImagePicker/issues/41) (Special Thanks to [benji101](https://github.com/benji101))
* Fixed uCrop Crash Issue [#42](https://github.com/Dhaval2404/ImagePicker/issues/42)
### Version: 1.5
* Fixed app crash issue, due to Camera Permission in manifest [#34](https://github.com/Dhaval2404/ImagePicker/issues/34)
* Added Option for Dynamic Crop Ratio. Let User choose aspect ratio [#36](https://github.com/Dhaval2404/ImagePicker/issues/36) (Special Thanks to [Dor-Sloim](https://github.com/Dor-Sloim))
### Version: 1.4
* Optimized Uri to File Conversion (Inspired by [Flutter ImagePicker](https://github.com/flutter/plugins/tree/master/packages/image_picker))
* Removed redundant CAMERA permission [#26](https://github.com/Dhaval2404/ImagePicker/issues/26) (Special Thanks to [PerrchicK](https://github.com/PerrchicK))
### Version: 1.3
* Sample app made compatible with Android Kitkat 4.4+ (API 19)
* Fixed Uri to File Conversion issue [#8](https://github.com/Dhaval2404/ImagePicker/issues/8) (Special Thanks to [squeeish](https://github.com/squeeish))
### Version: 1.2
* Added Support for Inline Activity Result(Special Thanks to [soareseneves](https://github.com/soareseneves))
* Fixed issue [#6](https://github.com/Dhaval2404/ImagePicker/issues/6)
### Version: 1.1
* Optimized Compression Logic
* Replace white screen with transparent one.
### Version: 1.0
* Initial Build
## 📃 Libraries Used
* uCrop [https://github.com/Yalantis/uCrop](https://github.com/Yalantis/uCrop)
* Compressor [https://github.com/zetbaitsu/Compressor](https://github.com/zetbaitsu/Compressor)
### Let us know!
We'll be really happy if you sent us links to your projects where you use our component. Just send an email to **[email protected]** And do let us know if you have any questions or suggestion regarding the library.
## License
Copyright 2019-2021, Dhaval Patel
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License 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.