Skip to content

About

Kotlin Multiplatform unified clipboard manager. Read/write text and images on Android & iOS via Compose API.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

cmp-clipboard

JitPack Build Status Platform Kotlin License

Compose MultiPlatform clipboard library for Kotlin — unified clipboard API for Android and iOS.

cmp-clipboard demo


⚡ Features

  • 📱 Unified API — single ClipboardManager interface works seamlessly on Android and iOS.
  • 📝 Text Clipboard — readText() / writeText(text) for plain text manipulation.
  • 🖼️ Image Clipboard — readImage() / writeImage(image) for rich visual clipboard payloads.
  • 🎨 Composable — rememberClipboardManager() hook for Compose Multiplatform UI.

📦 Installation

Add the JitPack repository and dependency to your build.gradle.kts:

repositories {
    maven { url = uri("https://jitpack.io") }
}

dependencies {
    implementation("com.github.govindtank:cmp-clipboard:1.0.0")
}

🚀 Usage

import androidx.compose.material3.*
import androidx.compose.runtime.*
import io.github.govindtank.clipboard.rememberClipboardManager

@Composable
fun ClipboardDemoScreen() {
    val clipboard = rememberClipboardManager()
    var pastedText by remember { mutableStateOf("") }
    
    Button(onClick = { clipboard.writeText("Hello from Compose Multiplatform!") }) {
        Text("Copy to Clipboard")
    }
    
    Button(onClick = { 
        pastedText = clipboard.readText() ?: "(Clipboard is empty)" 
    }) {
        Text("Paste from Clipboard")
    }

    Text("Current Clipboard: $pastedText")
}

📱 Platform Implementation Details

Platform Underlying API Notes
Android android.content.ClipboardManager Initialized with clipboardInit(context)
iOS platform.UIKit.UIPasteboard Works out of the box without context

💖 Support the Project

If you find this project useful, consider supporting its active maintenance and future development:

Buy Me A Coffee GitHub Sponsors Patreon


📄 License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Maintained with ❤️ by Govind Tank.

About

Kotlin Multiplatform unified clipboard manager. Read/write text and images on Android & iOS via Compose API.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages