peekaboo

To access the camera on iOS devices, you must add the Privacy - Camera Usage Description key to your Info.plist file. This provides the user with a description of why the app requires camera access.

<key>Privacy - Camera Usage Description</key>
<string>This app uses camera for capturing photos.</string>

Add the desired dependency to your commonMain configuration. The minimum supported Android SDK is 24 (Android 7.0).

Choose between:

• peekaboo-ui: Provides UI elements like a custom camera view for iOS and Android.
• peekaboo-image-picker: Provides functionality to select single or multiple images on iOS and Android.

commonMain {
    dependencies {
        // For UI components (Camera)
        implementation("io.github.onseok:peekaboo-ui:$latest_version")

        // For image selection
        implementation("io.github.onseok:peekaboo-image-picker:$latest_version")
    }
}

To pick multiple images with a limit and apply resizing, use SelectionMode.Multiple(maxSelection = n). The onResult callback returns a list of ByteArrays representing all selected and resized images.

val multipleImagePicker = rememberImagePickerLauncher(
    selectionMode = SelectionMode.Multiple(maxSelection = 5),
    scope = rememberCoroutineScope(),
    resizeOptions = resizeOptions,
    onResult = {
        byteArrays ->
        byteArrays.forEach {
            // Process the resized images' ByteArrays
            println(it)
        }
    }
)

To pick a single image and apply resizing, pass SelectionMode.Single and your ResizeOptions to rememberImagePickerLauncher. The onResult callback provides a list of ByteArrays; for single selection, you typically use .firstOrNull().

val singleImagePicker = rememberImagePickerLauncher(
    selectionMode = SelectionMode.Single,
    scope = rememberCoroutineScope(),
    resizeOptions = resizeOptions,
    onResult = {
        byteArrays ->
        byteArrays.firstOrNull()?.let {
            // Process the resized image's ByteArray
            println(it)
        }
    }
)

You can optimize image selection by providing resizeOptions to rememberImagePickerLauncher. This allows you to specify target dimensions, a file size threshold for when resizing should trigger, and compression quality.

Key behaviors:

• Aspect Ratio: The original aspect ratio is preserved; final dimensions may vary slightly to maintain proportions.
• Default Dimensions: 800 x 800 pixels.
• Default Threshold: 1MB (images larger than this will be resized).
• Compression Quality: A value from 0.0 to 1.0.

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)
)

Use rememberPeekabooCameraState to initialize and control the camera.

Parameters:

• initialCameraMode: The starting camera (front or back). Default is CameraMode.Back. Note: To switch modes during runtime, use PeekabooCameraState.toggleCamera instead of changing this parameter.
• onCapture: A lambda called when a photo is captured, providing the photo as a ByteArray? (null if capture fails).

State Properties:

• isCameraReady: Boolean indicating if the camera is available to be shown.
• isCapturing: Boolean indicating if a capture is currently in progress.
• cameraMode: The current CameraMode (front or back).

val state = rememberPeekabooCameraState(
    initialCameraMode = CameraMode.Back,
    onCapture = { byteArray -> 
        // Handle the captured image
    }
)

You can apply visual filters to selected images on both Android and iOS by setting the filterOptions parameter in rememberImagePickerLauncher.

Available filters:

• FilterOptions.Default: No filter applied (default).
• FilterOptions.GrayScale: Converts image to grayscale.
• FilterOptions.Sepia: Applies a sepia tone.
• FilterOptions.Invert: Inverts the colors.

val imagePicker = rememberImagePickerLauncher(
    selectionMode = SelectionMode.Single,
    scope = rememberCoroutineScope(),
    filterOptions = FilterOptions.GrayScale,
    onResult = {
        byteArrays ->
        // Process the filtered images' ByteArrays
    }
)

Use rememberGalleryPickerState to create and remember the state for a gallery picker UI. This state holds configuration values for the grid layout, such as padding, spacing, corner radius, and column count. The state is wrapped in rememberSaveable, meaning it will survive configuration changes (like screen rotations) using the internal GalleryPickerState.Saver.

val galleryState = rememberGalleryPickerState(
    contentPadding = 8,
    itemSpacing = 4,
    cornerSize = 12,
    columns = 4
)

When calling rememberGalleryPickerState, you can customize the following layout properties:

// Example of a highly customized grid
val galleryState = rememberGalleryPickerState(
    contentPadding = 16,
    itemSpacing = 8,
    cornerSize = 16,
    columns = 5
)

Use the toImageBitmap() extension function to convert a raw ByteArray (received from the image picker) into a Compose ImageBitmap for easy display in your UI.

val imageBitmap = byteArray.toImageBitmap()