MaterializeKMP
1.4.0indexedCompose Multiplatform library offers a Material Design 3 theme with essential components for seamless configuration across Android, iOS, Web, and Desktop environments.
2
Stars
—
Used by
dependents
—
Health
/ 100
🌗 KMP Material Theme (MaterializeKMP)
✨ Overview
MaterializeKMP is a Kotlin Multiplatform library for Compose Multiplatform that provides a Material Design 3–based theme system and essentials to keep your UI consistent across platforms.
Targets supported:
- Android
- iOS
- Desktop (JVM)
- Web (Wasm/JS)
The repository also contains a multiplatform Sample app demonstrating usage on all targets, plus an iOS host project.
🖥️ Demo
| Android | Web | iOS |
|---|---|---|
 |  |  |
🧰 Tech stack
- Language: Kotlin (2.0.20)
- UI: JetBrains Compose Multiplatform (1.7.0)
- Build: Gradle (Kotlin DSL) with Version Catalog
- Android Gradle Plugin: 8.5.2
- JDK: 17
- Modules:
- material-theme-kit (library, published as com.tarifchakder:material-theme)
- sample (KMP demo app: android, desktop, wasmJs, iOS)
- iosApp (Xcode project to run the sample on iOS)
🔧 Requirements
- JDK 17
- Android Studio (to run Android/Desktop and manage Gradle)
- Xcode (to run the iOS host project)
- Android SDK: compileSdk 36, minSdk 24, targetSdk 36
- macOS is required to build/run iOS targets
📦 Installation (use in your project)
Add the dependency to your commonMain source set:
commonMain {
dependencies {
implementation("com.tarifchakder:material-theme:1.1.0")
}
}
Using a Version Catalog:
[versions]
materialtheme = "1.1.0"
[libraries]
material-theme = { module = "com.tarifchakder:material-theme", version.ref = "materialtheme" }
▶️ Running the sample
Repository uses the Gradle Wrapper. Replace ./gradlew with gradlew.bat on Windows.
Note: For iOS, Gradle can build KMP frameworks for targets (iosX64/iosArm64/iosSimulatorArm64). The included Xcode project has been wired to the shared sample code via the generated framework; if something fails, open Xcode and let it resolve Swift packages and build steps.
📜 Scripts and useful Gradle tasks
🧪 Tests
- The library configures
commonTestwith Kotlin test dependencies, but no tests are currently present. - TODO: Add unit tests for color generation and theming behavior.
Run all tests:
./gradlew test
🗂 Project structure
Root settings: see settings.gradle.kts, versions in gradle/libs.versions.toml and version.properties.
📦 Features
- Material Design 3 theming
- Light/Dark themes
- Dynamic color palette support
- Works across Android, iOS, Desktop, Web/Wasm
- Easy integration via Gradle Version Catalogs
📖 Usage
See the sample for a complete setup. Core entry point for theming is DynamicTheme in the library. Example (simplified):
DynamicTheme(
seedColor = Color(0xFF00BCD4),
isDarkTheme = false,
isDynamicColor = true,
isAmoled = false,
isInvertColors = false
) {
// Your Compose UI here
}
🧾 License
MaterializeKMP is licensed under the MIT License.
This library draws inspiration from the Material Color Palette by the Material Foundation. For details on their licensing, see their LICENSE file:
- material-theme-kit/src/commonMain/kotlin/io/github/tarifchakder/materializekmp/materialcolor/LICENSE
See LICENSE for the repository license.
🤝 Contributing
Contributions are welcome! If you have an idea for a new feature or an enhancement:
- Fork the repository.
- Create a branch from
develop:git checkout -b feature/my-new-feature. - Open a pull request targeting
developand describe your changes.
Please consider adding tests and updating documentation for user-facing changes.