README.md

Catppuccin for Kotlin/Multiplatform

Installation

repositories {
    maven(url = "https://maven.d1s.dev/releases")
}

dependencies {
    val catppuccinKotlinVersion: String by project

    implementation("com.catppuccin:catppuccin-kotlin:$catppuccinKotlinVersion")
}

Example usage

import com.catppuccin.kotlin.*
import com.catppuccin.kotlin.color.*

// Get yellow color of palette Mocha
YellowPaletteColor(Palette.Mocha)
// or
paletteColorOf(yellow, mocha)
// or
yellow of mocha
// or
mocha.yellow

// Get yellow and rosewater colors of palette Latte
paletteColorsOf(yellow, rosewater, palette = latte)
// or
colors(yellow, rosewater) of latte

// Get all supported colors
allColors

// Get all palettes
allPalettes

// Get all colors of all palettes (basically every single color supported by Catppuccin)
allPaletteColors

What targets are currently supported?

Currently supported targets are JVM, WASM, and JS. Native targets are coming soon! Let me know if you miss the support of them.

Contributing

If you are looking to contribute, please read through our CONTRIBUTING.md first!

Development

The project can be built using the following command:

./gradlew build

If you want to publish to your local Maven repository:

./gradlew publishToMavenLocal

To run tests:

./gradlew test

CI/CD

This project has a GitHub actions workflow to automatically build binaries and deploy to Maven Central repository. The workflows are stored at .github/workflows

Thanks to

• Mikhail Titov

 

Copyright © 2021-present Catppuccin Org