share SETUP

cmp-share — Integration Guide

io.github.mobilebytelabs:cmp-share:3.2.11

cmp-share is zero-configuration — no init call, no DI module, no nav destinations. 3 steps: add dependency, opt in, use.

---

Step 1 — Add Gradle Dependency

gradle/libs.versions.toml

[versions]
cmp-share = "3.2.11"

[libraries]
cmp-share = { module = "io.github.mobilebytelabs:cmp-share", version.ref = "cmp-share" }

shared/build.gradle.kts

commonMain.dependencies {
    implementation(libs.cmp.share)
}

---

Step 2 — Opt in to the Experimental Marker

Per call-site (recommended)

@OptIn(ExperimentalShareApi::class)
suspend fun onShare() {
    Share.text("Hello from KMP!")
}

Project-wide (all modules)

// shared/build.gradle.kts
kotlin {
    compilerOptions {
        freeCompilerArgs.addAll("-opt-in=com.mobilebytelabs.kmptoolkit.share.ExperimentalShareApi")
    }
}

---

Step 3 — Use the API

Share plain text

@OptIn(ExperimentalShareApi::class)
suspend fun shareText() {
    val result = Share.text("Check out KMP Toolkit!")
    if (result is ShareResult.Failed) logError(result.cause)
}

Share a URL

val result = Share.url("https://github.com/mobilebytelabs/kmp-toolkit")

Share an image

val result = Share.image(
    bytes    = pngBytes,
    mimeType = "image/png",
    filename = "screenshot.png"
)

Share a file

val result = Share.file(
    bytes    = pdfBytes,
    mimeType = "application/pdf",
    filename = "report.pdf"
)

Share multiple payloads (Android / iOS / macOS)

val result = Share.multi(
    listOf(
        SharePayload.Text("Here's the file:"),
        SharePayload.File(pdfBytes, "application/pdf", "invoice.pdf")
    )
)

Custom options

val result = Share.share(
    payload = SharePayload.Text("Hello!"),
    options = ShareOptions(
        chooserTitle = "Share via",            // Android Chooser title
        excludedActivities = listOf("com.instagram.android")
    )
)

---

Platform Notes

Platform	Behaviour
Android	Native ACTION_SEND Chooser — chooserTitle and excludedActivities apply
iOS	UIActivityViewController — pass presentingController if not in a window
macOS	NSSharingServicePicker — pass presentingController (NSView anchor)
JVM	Desktop.open() / mailto: — best-effort, no result confirmation
JS / wasmJs	navigator.share() — must be called from a user gesture (e.g., click handler)

---

AI-Assisted Setup

/sync-share           # Verify Gradle dependency (only gate needed)
/sync-share --check   # Dry run — show status, no writes

See CLAUDE_AI_SETUP.md for full docs.