Skip to content

Installation

Gradle Dependency

Add the dependency to your commonMain source set:

build.gradle.kts
kotlin {
sourceSets {
commonMain.dependencies {
implementation("io.github.aldefy:shelf:<version>")
}
}
}

Version Catalog

gradle/libs.versions.toml
[versions]
compose-shelf = "<version>"
[libraries]
compose-shelf = { module = "io.github.aldefy:shelf", version.ref = "compose-shelf" }

Then reference it:

commonMain.dependencies {
implementation(libs.compose.shelf)
}

Platform Artifacts

Gradle resolves the correct artifact automatically. For reference:

PlatformArtifact ID
Androidshelf-android
JVM Desktopshelf-jvm
iOS arm64shelf-iosarm64
iOS Simulator arm64shelf-iossimulatorarm64
iOS x64shelf-iosx64
WasmJsshelf-wasmjs

Requirements

  • Kotlin 2.1.0+
  • Compose Multiplatform 1.7.0+
  • Android minSdk 23 (if targeting Android)

Dependencies

Compose Shelf has zero Material dependency. It only depends on:

  • compose.runtime
  • compose.foundation
  • compose.ui
  • compose.animation

This means it works with any design system — Material 3, Material 2, or custom.