Capturable

2.0.2indexed

Utility library facilitates conversion of composable content into ImageBitmap, enabling asynchronous capture and sharing or saving of components. Ideal for modern UI frameworks.

AndroidJSJVMNativeWasm·jmseb3/Capturable

Stars

—

Used by

dependents

—

Health

/ 100

Capturable

Compose Multiplatform utility library for capturing Composable content as ImageBitmap.

Thanks to @PatilShreyas for the original inspiration.

Maven Central Version badge-android badge-ios badge-desktop badge-js

Introduction

Capturable makes it easy to capture Compose UI content into bitmap images across platforms.

Modules

io.github.jmseb3:capturable: core capture API (CaptureController, Modifier.capturable)
io.github.jmseb3:capturableExtension: optional save/share helpers built on top of FileKit

Installation

Version catalog (`libs.versions.toml`)

[versions]
capturable = "2.0.2"

[libraries]
capturable = { module = "io.github.jmseb3:capturable", version.ref = "capturable" }
capturable-extension = { module = "io.github.jmseb3:capturableExtension", version.ref = "capturable" }

dependencies {
    implementation(libs.capturable)
    implementation(libs.capturable.extension)
}

Direct dependency

dependencies {
    implementation("io.github.jmseb3:capturable:2.0.2")
    implementation("io.github.jmseb3:capturableExtension:2.0.2")
}

Latest versions and changelog: Releases

Quick Start

1. Create a controller

@Composable
fun TicketScreen() {
    val captureController = rememberCaptureController()
}

2. Mark target content as capturable

@Composable
fun TicketScreen() {
    val captureController = rememberCaptureController()

    Column(modifier = Modifier.capturable(captureController)) {
        MovieTicketContent(...)
    }
}

3. Capture asynchronously

val scope = rememberCoroutineScope()

Button(onClick = {
    scope.launch {
        runCatching { captureController.captureAsync().await() }
            .onSuccess { bitmap -> /* use bitmap */ }
            .onFailure { error -> error.printStackTrace() }
    }
}) { ... }

Extension (Save/Share)

If you need captureAsyncAndSave or captureAsyncAndShare, use capturableExtension.

It depends on FileKit. Follow the FileKit setup guide.

Android initialization example:

class MainActivity : ComponentActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        FileKit.init(this)
    }
}