Getting Started Installation

Installation

FormaUI 0.2.0 is live on Maven Central. Add one dependency to your Android module, wrap your app in the theme, and start dropping in components.

On Maven CentralKotlin 2.4+Android minSdk 24+Jetpack Compose

Add the dependency

Add FormaUI to your shared/common module’s Gradle dependencies.

build.gradle.ktsGRADLE KTS

123dependencies {
    implementation("dev.formaui:components:0.2.0")
}

Or use a version catalog

If your project centralizes dependencies in gradle/libs.versions.toml, declare FormaUI there instead.

gradle/libs.versions.tomlTOML

12345[versions]
formaui = "0.2.0"
 
[libraries]
formaui-components = { module = "dev.formaui:components", version.ref = "formaui" }

Wrap your app in FormaTheme

Every FormaUI component reads its colors, type, spacing, and shape from FormaTheme. Install it once, at the root of your composition.

App.ktKOTLIN

12345678@Composable
fun App() {
    FormaTheme(darkTheme = isSystemInDarkTheme()) {
        Surface {
            HomeScreen()
        }
    }
}

Use your first component

Everything inside FormaTheme already matches the brand theme — no per-component styling required.

HomeScreen.ktKOTLIN

123FormaButton(onClick = { navigate() }) {
    Text("Get started")
}

Dynamic color

Material You dynamic color needs Android 12+ (API 31). On older Android versions — and in this site’s browser previews — FormaUI falls back to the static brand palette shown across this site, no configuration needed.

PreviousOverview Next Button