Quickstart: Compose Desktop

Kotlin Multiplatform with Compose Desktop runs the same SDK on Windows, macOS and Linux.

1. Install

Build version 1.0.0 from its Git tag into your local Maven repository (git clone --branch 1.0.0 https://github.com/tweaklane/tweaklane-android, then ./gradlew :tweaklane:publishToMavenLocal), add mavenLocal() to your repositories and the dependency to your desktop source set:

kotlin {
    jvm("desktop")
    sourceSets {
        val desktopMain by getting {
            dependencies {
                implementation("com.tweaklane:tweaklane-android:1.0.0")
            }
        }
    }
}

2. Same model on every platform

1. Register each component in a catalog: a stable id, a Composable builder, a props schema, its alternatives and a lock level.
2. Provide a default document per screen.
3. Create the engine and render each screen through it.
4. Start edit mode where your app wants it.
5. Connect sync with your public SDK key, your {TWEAKLANE_URL} and a token provider.

The layout documents, manifest, validation rules and issue codes are the same as on every other SDK. Source: https://github.com/tweaklane/tweaklane-android.