https://github.com/gabrieldrn/carbon-compose

Carbon design system implementation with KMP and Compose Multiplatform
https://github.com/gabrieldrn/carbon-compose

android carbon-design-system compose-multiplatform design-system kotlin-library kotlin-multiplatform kotlin-native wasm

Last synced: 16 days ago
JSON representation

Carbon design system implementation with KMP and Compose Multiplatform

• Host: GitHub
• URL: https://github.com/gabrieldrn/carbon-compose
• Owner: gabrieldrn
• License: apache-2.0
• Created: 2023-10-20T04:17:10.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-10T14:20:25.000Z (25 days ago)
• Last Synced: 2025-01-10T15:29:58.745Z (24 days ago)
• Topics: android, carbon-design-system, compose-multiplatform, design-system, kotlin-library, kotlin-multiplatform, kotlin-native, wasm
• Language: Kotlin
• Homepage: https://gabrieldrn.github.io/carbon-compose/
• Size: 6.49 MB
• Stars: 169
• Watchers: 3
• Forks: 11
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• kmp-awesome - Carbon Compose - IBM's Carbon design system in Compose multiplatform. (Libraries / 🍎 Compose UI)

README

        


# Carbon | Compose Multiplatform

![Carbon catalog pres](https://github.com/user-attachments/assets/d55e6893-ab18-498f-abec-1e2998dfe293)

[![Kotlin](https://img.shields.io/badge/2.0.20-blue?logo=kotlin&logoColor=white&color=7F52FF)](http://kotlinlang.org)

[![Compose Multiplatform](https://img.shields.io/badge/1.7.0-green?logo=jetpackcompose&logoColor=white&color=4284F3)](https://www.jetbrains.com/lp/compose-multiplatform)

[![CI | compile & tests](https://github.com/gabrieldrn/carbon-compose/actions/workflows/ci-lib-workflow.yml/badge.svg)](https://github.com/gabrieldrn/carbon-compose/actions/workflows/ci-lib-workflow.yml)

A [Compose Multiplatform](https://www.jetbrains.com/lp/compose-multiplatform/) implementation of the [Carbon Design System](https://github.com/carbon-design-system/carbon).

**Supported platforms:**

- Android

- iOS

- Desktop

- Web via Wasm

> [!CAUTION]

> This library is **still under development** and **unofficial**. Contributions are welcomed!

# 🤳 Catalog App

For testing purposes, this project provides a _catalog_ app for supported targets.

As this is a KMP project, please follow [those steps](https://www.jetbrains.com/help/kotlin-multiplatform-dev/multiplatform-setup.html) to setup your environment accordingly.

## Android 🤖

You can either run the app from the Android App run configuration in Android Studio, or compile an APK by executing the assemble task in a terminal:

```

./gradlew :catalog:assemble

```

## iOS 

To run the iOS catalog app, open the Xcode project located in `/iosCatalog` and run it (⌘R).

## Desktop 🖥️

You can run the desktop version by executing the `run` Gradle task in a terminal:

```

./gradlew :catalog:run

```

## Browser 🌐

You can access the web catalog app at https://gabrieldrn.github.io/carbon-compose/catalog/index.html. 

Or you can run the web version locally by executing the `wasmJsBrowserRun` Gradle task in a terminal:

```

./gradlew :catalog:wasmJsBrowserRun

```

# Documentation

Visit the project's Github Pages https://gabrieldrn.github.io/carbon-compose/ to get more information about the

project, some documentation, its API reference and the catalog app. 

# Contributions

The project is open for contributions, have a look at the contribution guidelines and the issues list!

# Support the project 🫶 

Maintaining a free and open-source project takes time! If you like it and would like to encourage me, you can:

- Star and share the project,

- Offer me a latte ☕ (my daily fuel) with the GitHub sponsoring button on this repository main page.

  

Thank you very much for your support!

---

Content featuring carbon-compose: