https://github.com/nicosnicolaou16/imagepickerandroid
🏞 Image and Video Picker library for Android, support Base64 value(s) from Image(s) and support Layout and Jetpack Compose
https://github.com/nicosnicolaou16/imagepickerandroid
android android-library androiddev base64 base64-image compose converter-image-to-base64 development image-picker-android image-video-picker-android jetpack-compose kotlin layout layout-android multiple-images-picker picker picker-library resize-images video-picker-android view
Last synced: about 2 months ago
JSON representation
🏞 Image and Video Picker library for Android, support Base64 value(s) from Image(s) and support Layout and Jetpack Compose
- Host: GitHub
- URL: https://github.com/nicosnicolaou16/imagepickerandroid
- Owner: NicosNicolaou16
- License: apache-2.0
- Created: 2023-05-06T21:12:49.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-14T20:02:36.000Z (8 months ago)
- Last Synced: 2024-09-16T04:52:41.212Z (8 months ago)
- Topics: android, android-library, androiddev, base64, base64-image, compose, converter-image-to-base64, development, image-picker-android, image-video-picker-android, jetpack-compose, kotlin, layout, layout-android, multiple-images-picker, picker, picker-library, resize-images, video-picker-android, view
- Language: Kotlin
- Homepage:
- Size: 265 KB
- Stars: 27
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Image Picker Android
This library is built to provide other developers with an easy way to implement an image picker in
Android applications using the latest Android technologies. It supports Activities, Fragments with
XML, and Jetpack Compose.
Support me, and I would appreciate any feedback you provide.
Note: The example project does not include examples for all methods.
The library contains/features:
- Picker for a single image from the gallery.
- Picker for multiple images from the gallery (up to 9 images).
- Camera picker for a single image (with permission handling - manage the scenario where camera
permission is permanently denied by directing the user to the app settings to modify the
permission).
- Video picker.
- Retrieve the base64 value.
- Image scaling (resize) – available only for images.
- All of the above features are also supported in Jetpack Compose.
- New updates coming soon! Feel free to share your suggestions.
Reasons to use this library
- It supports both Activity and Fragment with XML, as well as Jetpack Compose, ensuring compatibility with various Android development approaches.
- The library provides a user-friendly way to integrate image picking functionalities, saving time and effort.
- It offers advanced features like base64 encoding support and image scaling, enhancing your app's image handling capabilities.
### Versioning
Gradle Version 8.7.3
Kotlin Version 2.1.0
JDK Version 17
Minimum SDK 24
Target SDK 35
Build Tool Version 35
## IMPORTANT NOTE
THE BETA RELEASES MAY CONTAIN MAJOR OR MINOR CHANGES.
> [!IMPORTANT]
> Breaking changes for the version 2.3.0
> `takeSingleCameraImage()` changed to `takeSingleCameraImage(context = context)`
> `takeSingleCameraImageWithBase64Value()` changed to
`takeSingleCameraImageWithBase64Value(context = context)`
## Basic Configuration (Gradle Dependencies)
[](https://jitpack.io/#NicosNicolaou16/ImagePickerAndroid)
### Groovy
```Groovy
implementation 'com.github.NicosNicolaou16:ImagePickerAndroid:2.3.0'
```
```Groovy
allprojects {
repositories {
maven { url "https://jitpack.io" }
}
}
```
### Kotlin DSL
```Kotlin
implementation("com.github.NicosNicolaou16:ImagePickerAndroid:2.3.0")
```
```Kotlin
dependencyResolutionManagement {
//...
repositories {
//...
maven { url = uri("https://jitpack.io") }
}
}
```
### libs.versions.toml
```toml
[versions]
# other versions here...
imagePickerAndroid = "2.3.0"
[libraries]
# other libraries here...
image-picker-android = { group = "com.github.NicosNicolaou16", name = "ImagePickerAndroid", version.ref = "imagePickerAndroid" }
```
```Kotlin
implementation(libs.image.picker.android)
```
```Kotlin
dependencyResolutionManagement {
//...
repositories {
//...
maven { url = uri("https://jitpack.io") }
}
}
```
## Standard Configuration (XML)
### Step 1 - Get Instance
```Kotlin
class MainActivity : AppCompatActivity(), ImagePickerInterface {
//...
private var imagePicker: ImagePicker? = null
//...
fun initImagePicker() {
//Builder
//Note: fragmentActivity or fragment are mandatory one of them
imagePicker = ImagePicker(
fragmentActivity = this, //activity instance - private
fragment = this, // fragment instance - private
coroutineScope = lifecycleScope, // mandatory - coroutine scope from activity or fragment - private
scaleBitmapModelForSingleImage = ScaleBitmapModel(
height = 100,
width = 100
), // optional, change the scale for image, by default is null
scaleBitmapModelForMultipleImages = ScaleBitmapModel(
height = 100,
width = 100
), // optional, change the scale for image, by default is null
scaleBitmapModelForCameraImage = ScaleBitmapModel(
height = 100,
width = 100
), // optional, change the scale for image, by default is null
enabledBase64ValueForSingleImage = true, // optional, by default is false - private
enabledBase64ValueForMultipleImages = true, // optional, by default is false - private
enabledBase64ValueForCameraImage = true, // optional, by default is false - private
imagePickerInterface = this // call back interface
)
//...other image picker initialization method(s)
}
//...
}
```
### Step 2 - Initialize the methods for Image Pickers (choose the preferred method(s))
```Kotlin
imagePicker?.initPickSingleImageFromGalleryResultLauncher()
imagePicker?.initPickMultipleImagesFromGalleryResultLauncher()
imagePicker?.initTakePhotoWithCameraResultLauncher()
imagePicker?.initPickSingleVideoFromGalleryResultLauncher()
```
### Step 3 Call from Click Listeners (choose the preferred method(s))
```Kotlin
imagePicker?.pickSingleImageFromGallery()
imagePicker?.pickMultipleImagesFromGallery()
imagePicker?.takeSinglePhotoWithCamera()
imagePicker?.pickSingleVideoFromGallery()
```
### Step 4 - Callbacks (Optionals)
```Kotlin
class MainActivity : AppCompatActivity(), ImagePickerInterface {
//...
override fun onGallerySingleImage(bitmap: Bitmap?, uri: Uri?) {
super.onGalleryImage(bitmap, uri)
//...your code here
}
override fun onCameraImage(bitmap: Bitmap?) {
super.onCameraImage(bitmap)
//...your code here
}
override fun onMultipleGalleryImages(
bitmapList: MutableList?,
uriList: MutableList?
) {
super.onMultipleGalleryImages(bitmapList, uriList)
//...your code here
}
override fun onGallerySingleImageWithBase64Value(
bitmap: Bitmap?,
uri: Uri?,
base64AsString: String?
) {
super.onGalleryImage(bitmap, uri, base64AsString)
//...your code here
}
override fun onCameraImageWithBase64Value(bitmap: Bitmap?, base64AsString: String?) {
super.onCameraImage(bitmap, base64AsString)
//...your code here
}
override fun onMultipleGalleryImagesWithBase64Value(
bitmapList: MutableList?,
uriList: MutableList?,
base64AsStringList: MutableList?
) {
super.onMultipleGalleryImages(bitmapList, uriList, base64AsStringList)
//...your code here
}
override fun onGallerySingleVideo(uri: Uri?) {
super.onGallerySingleVideo(uri)
//...your code here
}
}
```
## Compose Configuration
### Step 1 - Initialize the Callbacks (Optionals)
```Kotlin
PickSingleImage(
scaleBitmapModel = ScaleBitmapModel(
height = 100,
width = 100
), listener = { bitmap, uri ->
//...your code here
})
PickSingleImageWithBase64Value(
scaleBitmapModel = null,
listener = { bitmap, uri, base64 ->
//...your code here
})
PickMultipleImages(
scaleBitmapModel = null,
listener = { bitmapList, uriList ->
//...your code here
})
PickMultipleImagesWithBase64Values(
scaleBitmapModel = null,
listener = { bitmapList, uriList, base64List ->
//...your code here
})
TakeSingleCameraImage(
scaleBitmapModel = null,
listener = { bitmap, uri ->
//...your code here
})
TakeSingleCameraImageWithBase64Value(
scaleBitmapModel = null,
listener = { bitmap, uri, base64 ->
//...your code here
})
PickSingleVideo(listener = { uri ->
//...your code here
})
```
### Step 2 Call from Click Listeners (choose the preferred method(s))
```Kotlin
pickSingleImage()
pickSingleImageWithBase64Value()
pickMultipleImages()
pickMultipleImagesWithBase64Values()
takeSingleCameraImage(context = context)
takeSingleCameraImageWithBase64Value(context = context)
pickSingleVideo()
```
### Example for Compose Implementation
```kotlin
@Composable
fun ImagePicker() {
val context = LocalContext.current
val bitmapValue = remember {
mutableStateOf(Bitmap.createBitmap(100, 100, Bitmap.Config.ARGB_8888))
}
//Initialize the call back
PickSingleImage(scaleBitmapModel = null, listener = { bitmap, uri ->
if (bitmap != null) {
bitmapValue.value = bitmap
}
})
Column(
modifier = Modifier.fillMaxSize(),
verticalArrangement = Arrangement.spacedBy(20.dp, alignment = Alignment.Top),
horizontalAlignment = Alignment.CenterHorizontally,
) {
//other code
Button(modifier = Modifier.size(150.dp, 50.dp), onClick = {
//pick image from the gallery
pickSingleImage()
}) {
Text(
text = stringResource(R.string.pick_single_image),
style = TextStyle(textAlign = TextAlign.Center)
)
}
//other code
}
}
```