garnish

Modular primitives for common mobile system tasks—share, haptic, torch, screen, clipboard, badge, in‑app review—with explicit APIs, minimal dependencies and Compose helpers.

#ui
#sdk
#maven
#kotlin-multiplatform-sample
#gradle
#compose
#apple

Suggest an edit

Android JVMKotlin/Native

GitHub stars0

Authorsszijpeter

Open issues1

LicenseApache License 2.0

Creation date8 days ago

Last activity6 days ago

Latest release0.1.0 (7 days ago)

Homepage GitHub repository

Garnish

Small, focused Kotlin Multiplatform primitives for common mobile system tasks.

Description

Garnish is a modular KMP suite for system-level features that should be easy to use across Android and iOS.

One feature per module.
Explicit APIs with deterministic runtime behavior.
Thin dependencies so apps can pick only what they actually need.

Setup

Consume From Maven Central (Primary)

Add dependencies from Maven Central:

repositories {
    google()
    mavenCentral()
}

dependencies {
    commonMainImplementation("io.github.szijpeter:garnish-share:<version>")
    commonMainImplementation("io.github.szijpeter:garnish-share-compose:<version>") // Compose helper module
    commonMainImplementation("io.github.szijpeter:garnish-review:<version>")
    // Pick only the modules your app needs.
}

Example

@Composable
fun ShareExample() {
    val shareKit = rememberShareKit()
    Button(onClick = { shareKit.shareText("Don't panic.") }) {
        Text("Share")
    }
}

Local Development (Maintainers)

./gradlew check apiCheck --no-daemon
./gradlew publishToMavenLocal --no-daemon

In a local consumer project during development:

repositories {
    mavenLocal()
    google()
    mavenCentral()
}

Publishing guide: docs/MAVEN_CENTRAL.md

Modules

Module(s)	Description
`share` + `share-compose`	Share text, URL, image, file and Compose `rememberShareKit()` helper
`haptic` + `haptic-compose`	Cross-platform haptic feedback and Compose engine/modifier helpers
`torch` + `torch-compose`	Flashlight control and Compose `rememberTorch()` helper
`screen` + `screen-compose`	Brightness, keep-screen-on, orientation and Compose lifecycle helpers
`badge`	App icon badge count
`clipboard` + `clipboard-compose`	Rich clipboard and Compose `rememberRichClipboard()` helper
`review`	In-app review request API

Sample App

Compose sample UI covering all modules: composeApp/src/commonMain/kotlin/dev/garnish/app/App.kt

Android	iOS

License: Apache-2.0. See LICENSE.