📸Image Picker for Android, Pick an image from Gallery or Capture a new image with Camera
APACHE-2.0 License
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.
Profile Image Picker | Gallery Only | Camera Only |
---|---|---|
Gradle dependency:
allprojects {
repositories {
maven { url "https://jitpack.io" }
}
}
implementation 'com.github.dhaval2404:imagepicker:2.1'
If you are yet to Migrate on AndroidX, Use support build artifact:
implementation 'com.github.dhaval2404:imagepicker-support:1.7.1'
The ImagePicker configuration is created using the builder pattern.
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
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()
Handling results
Override onActivityResult
method and handle ImagePicker result.
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
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
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
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)
}
Pick image using Gallery
ImagePicker.with(this)
.galleryOnly() //User can only select image from Gallery
.start() //Default Request Code is ImagePicker.REQUEST_CODE
Capture image using Camera
ImagePicker.with(this)
.cameraOnly() //User can only capture image using Camera
.start()
Crop image
ImagePicker.with(this)
.crop() //Crop image and let user choose aspect ratio.
.start()
Crop image with fixed Aspect Ratio
ImagePicker.with(this)
.crop(16f, 9f) //Crop image with 16:9 aspect ratio
.start()
Crop square image(e.g for profile)
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)
ImagePicker.with(this)
.compress(1024) //Final image size will be less than 1 MB
.start()
Set Resize image resolution
ImagePicker.with(this)
.maxResultSize(620, 620) //Final image resolution will be less than 620 x 620
.start()
Intercept ImageProvider, Can be used for analytics
ImagePicker.with(this)
.setImageProviderInterceptor { imageProvider -> //Intercept ImageProvider
Log.d("ImagePicker", "Selected ImageProvider: "+imageProvider.name)
}
.start()
Intercept Dialog dismiss event
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())
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
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
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.
<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>
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.
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.