Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/onseok/peekaboo
🌄 Kotlin Multiplatform library for Compose Multiplatform, designed for seamless integration of an image picker feature in iOS and Android applications.
https://github.com/onseok/peekaboo
android compose-multiplatform image-picker image-picker-android ios kmp-camera kmp-image kotlin kotlin-multiplatform kotlin-multiplatform-camera
Last synced: about 1 month ago
JSON representation
🌄 Kotlin Multiplatform library for Compose Multiplatform, designed for seamless integration of an image picker feature in iOS and Android applications.
- Host: GitHub
- URL: https://github.com/onseok/peekaboo
- Owner: onseok
- License: apache-2.0
- Created: 2023-11-21T12:12:36.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-26T13:54:05.000Z (9 months ago)
- Last Synced: 2024-04-12T17:07:19.142Z (8 months ago)
- Topics: android, compose-multiplatform, image-picker, image-picker-android, ios, kmp-camera, kmp-image, kotlin, kotlin-multiplatform, kotlin-multiplatform-camera
- Language: Kotlin
- Homepage:
- Size: 368 KB
- Stars: 92
- Watchers: 2
- Forks: 12
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - peekaboo
- awesome-list - onseok/peekaboo - 🌄 Kotlin Multiplatform library for Compose Multiplatform, designed for seamless integration of an image picker feature in iOS and Android applications. (Kotlin)
README
# peekaboo
[](http://kotlinlang.org)
[](https://github.com/JetBrains/compose-multiplatform)
[](https://search.maven.org/search?q=g:io.github.onseok)
[](https://opensource.org/licenses/Apache-2.0)
[](https://github.com/onseok/peekaboo/actions/workflows/ci_check.yml)
[](https://androidweekly.net/issues/issue-601)
📂 Kotlin Multiplatform library for Compose Multiplatform, designed for seamless integration of an image picker feature in iOS and Android applications.
## Getting started
### Compose Multiplatform
`peekaboo` is based on `Compose Multiplatform`, currently targeting only `iOS` and `Android`.
Please note that it primarily focuses on these platforms, and additional platforms may be considered in the future.
When using `peekaboo` on Android, ensure that Google's Jetpack Compose version is compatible with `peekaboo`'s Compose Multiplatform version.
## Installation
The minimum supported Android SDK is 24 (Android 7.0).
In your `commonMain` configuration, add the desired dependency, either **`peekaboo-ui`** or **`peekaboo-image-picker`**, to your project. Both are available on Maven Central.
### Without Version Catalog
```kotlin
commonMain {
dependencies {
// peekaboo-ui
implementation("io.github.onseok:peekaboo-ui:$latest_version")
// peekaboo-image-picker
implementation("io.github.onseok:peekaboo-image-picker:$latest_version")
}
}
```
### With Version Catalog
First, define the version in `libs.versions.toml`:
```toml
[versions]
peekaboo = "0.5.2"
[libraries]
peekaboo-ui = { module = "io.github.onseok:peekaboo-ui", version.ref = "peekaboo" }
peekaboo-image-picker = { module = "io.github.onseok:peekaboo-image-picker", version.ref = "peekaboo" }
```
Then, in your `commonMain` configuration, reference the defined version:
```kotlin
commonMain {
dependencies {
// peekaboo-ui
implementation(libs.peekaboo.ui)
// peekaboo-image-picker
implementation(libs.peekaboo.image.picker)
}
}
```
### Artifacts
| Name | Description |
|-------------------------|-----------------------------------------------------------------------------|
| `peekaboo-ui` |Provides user-friendly UI elements, including a custom camera view for easy image capture, suitable for both `iOS` and `Android` platforms. |
| `peekaboo-image-picker` | Simplifies the process of selecting single or multiple images both in `iOS` and `Android` platforms. |
## Usage
### Xcode setup
In order to access the camera on iOS devices, it's essential to include a specific key-value pair in the `Info.plist` file of your iOS project. This key-value pair comprises a key that identifies the type of permission being requested and a value that provides a user-friendly description explaining why the app needs access to the camera.
Here's the key-value pair you should add to your `Info.plist`:
```xml
Privacy - Camera Usage Description
This app uses camera for capturing photos.
```
### Custimizable Camera UI
`PeekabooCamera` is a `composable` function that provides a customizable camera UI within a `Compose Multiplatform` application.
### Simple Camera UI
```kotlin
@Composable
fun CustomCameraView() {
val state = rememberPeekabooCameraState(onCapture = { /* Handle captured images */ })
PeekabooCamera(
state = state,
modifier = Modifier.fillMaxSize(),
permissionDeniedContent = {
// Custom UI content for permission denied scenario
},
)
}
```
### Camera UI with overlay
```kotlin
@Composable
fun CustomCameraView() {
val state = rememberPeekabooCameraState(onCapture = { /* Handle captured images */ })
Box(modifier = Modifier.fillMaxSize()) {
PeekabooCamera(
state = state,
modifier = Modifier.fillMaxSize(),
permissionDeniedContent = {
// Custom UI content for permission denied scenario
},
)
// Draw here UI you need with provided state
YourCameraOverlay(
state = state,
modifier = Modifier.fillMaxSize(),
)
}
}
```
- **`state`** : The `PeekabooCameraState` to control camera.
- **`permissionDeniedContent`** : An optional `composable` lambda that provides content to be displayed when camera permission is denied. This allows users to define a custom UI to inform or guide the user when camera access has been denied. The content can be informative text, an image, a button to redirect the user to settings, or any other `composable` content. This lambda will be invoked within the `PeekabooCamera` composable scope, replacing the camera preview with the user-defined UI.
### Camera state
```kotlin
rememberPeekabooCameraState(
initialCameraMode: CameraMode = CameraMode.Back,
onCapture: (ByteArray?) -> Unit,
)
```
- **`initialCameraMode`** : The initial camera mode (front or back). Default is [CameraMode.Back]. Changes does not affect state. To toggle use [PeekabooCameraState.toggleCamera]
- **`onCapture`** : A lambda called when a photo is captured, providing the photo as a ByteArray or null if the capture fails.
- **`PeekabooCameraState.isCameraReady`** : True if camera already available for show
- **`PeekabooCameraState.isCapturing`** : True if camera is in progress of capture
- **`PeekabooCameraState.cameraMode`** : Current camera mode (front or back)
#### Capturing an Image from Camera
| Android | iOS |
|-----------------------------------------------------------------|---------------------------------------------------------|
| 
| 
|
#### Toggling Camera Mode Between Front and Back
| Android | iOS |
|-----------------------------------------------------------------|---------------------------------------------------------|
| 
| 
|
#### Handling Denied Camera Permissions
| Android | iOS |
|-----------------------------------------------------------------|---------------------------------------------------------|
| 
| 
|
### Select Single Image
```kotlin
val scope = rememberCoroutineScope()
val singleImagePicker = rememberImagePickerLauncher(
selectionMode = SelectionMode.Single,
scope = scope,
onResult = { byteArrays ->
byteArrays.firstOrNull()?.let {
// Process the selected images' ByteArrays.
println(it)
}
}
)
Button(
onClick = {
singleImagePicker.launch()
}
) {
Text("Pick Single Image")
}
```
| Android | iOS |
|-----------------------------------------------------------------|---------------------------------------------------------|
| 
| 
|
Simply select the desired image with an intuitive interface.
### Select Multiple Images
If you want to select multiple images, you can use `SelectionMode.Multiple()`. And you can set the maximum number of images to select.
If you didn't set max selection, the default value is maximum number that the system supports.
```kotlin
val scope = rememberCoroutineScope()
val multipleImagePicker = rememberImagePickerLauncher(
// Optional: Set a maximum selection limit, e.g., SelectionMode.Multiple(maxSelection = 5).
// Default: No limit, depends on system's maximum capacity.
selectionMode = SelectionMode.Multiple(maxSelection = 5),
scope = scope,
onResult = { byteArrays ->
byteArrays.forEach {
// Process the selected images' ByteArrays.
println(it)
}
}
)
Button(
onClick = {
multipleImagePicker.launch()
}
) {
Text("Pick Multiple Images")
}
```
| Android | iOS |
|-----------------------------------------------------------------|---------------------------------------------------------|
| 
| 
|
## Image Resizing Options
`peekaboo` offers customizable resizing options for both single and multiple image selections, along with a new feature to resize images only if they exceed a certain file size.
This feature allows you to resize the selected images to specific dimensions, optimizing them for your application's requirements and enhancing performance.
- The default resizing dimensions are set to `800 x 800` pixels.
- The default threshold for resizing is set to `1MB`, meaning images larger than this size will be resized.
- You can customize the resizing **dimensions**, **threshold**, and now the **compression quality** according to your needs.
### Usage
Set the `resizeOptions` parameter in `rememberImagePickerLauncher` with your desired dimensions, threshold and compression quality:
```kotlin
val resizeOptions = ResizeOptions(
width = 1200, // Custom width
height = 1200, // Custom height
resizeThresholdBytes = 2 * 1024 * 1024L, // Custom threshold for 2MB,
compressionQuality = 0.5 // Adjust compression quality (0.0 to 1.0)
)
```
#### Single Image Selection with Resizing
```kotlin
val singleImagePicker = rememberImagePickerLauncher(
selectionMode = SelectionMode.Single,
scope = rememberCoroutineScope(),
resizeOptions = resizeOptions,
onResult = { byteArrays ->
byteArrays.firstOrNull()?.let {
// Process the resized image's ByteArray
println(it)
}
}
)
```
#### Multiple Images Selection with Resizing
```kotlin
val multipleImagePicker = rememberImagePickerLauncher(
selectionMode = SelectionMode.Multiple(maxSelection = 5),
scope = rememberCoroutineScope(),
resizeOptions = resizeOptions,
onResult = { byteArrays ->
byteArrays.forEach {
// Process the resized images' ByteArrays
println(it)
}
}
)
```
>💡 Note: While resizing, the aspect ratio of the original images is preserved. The final dimensions may slightly vary to maintain the original proportions.
## Image Filter Options
**`peekaboo-image-picker`** now offers customizable filter options for selected images.
This feature is available on both `Android` and `iOS` devices.
| Default | GrayScale | Sepia | Invert |
|-----------------------------------------------------------------|---------------------------------------------------------|---------------------------------------------------------|---------------------------------------------------------|
| 
| 
| 
| 
|
### Usage
Set the `filterOptions` parameter in `rememberImagePickerLauncher`:
```kotlin
val imagePicker = rememberImagePickerLauncher(
selectionMode = SelectionMode.Single,
scope = rememberCoroutineScope(),
filterOptions = FilterOptions.GrayScale,
onResult = { byteArrays ->
// Process the filtered images' ByteArrays
}
)
```
>💡 Note: The default filter option is `Default`, which applies no filter.
> Choose from `GrayScale`, `Sepia`, or `Invert` for different effects.
## ByteArray to ImageBitmap Conversion
We've added a new extension function `toImageBitmap()` to convert a `ByteArray` into an `ImageBitmap`.
This function simplifies the process of converting image data into a displayable format, enhancing the app's capability to handle image processing efficiently.
### Usage
```kotlin
val imageBitmap = byteArray.toImageBitmap()
```
## Contributions 🙏
Contributions are always welcome!
If you'd like to contribute, please feel free to create a PR or open an issue. 👍
## Stargazers :star:
Support it by joining __[stargazers](https://github.com/onseok/peekaboo/stargazers)__ for this repository. :star:
## License
```
Copyright 2024 onseok
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
https://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.
```