Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
andresmr authored Sep 27, 2024
1 parent eae8f84 commit 7df54d8
Showing 1 changed file with 1 addition and 48 deletions.
49 changes: 1 addition & 48 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,6 @@
# DHIS2 Mobile UI

> **@dhis2/dhis2-mobile-ui** is
> a [Compose Multiplatform](https://www.jetbrains.com/lp/compose-multiplatform/) DHIS2 design system
> library for [Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html) applications.
**DHIS2 Mobile UI library** is based in
the [DHIS2 Mobile Design System Figma library](https://www.figma.com/file/eRk6bt0B8BJlTO9PZXirHN/DHIS2-Mobile-Design-System).

This library currently supports **desktop** and **Android** targets, in the next versions it will
support **iOS** and **web**.

## Installation

In the module **build.gradle.kts**:

```kotlin
dependencies {
implementation("org.hisp.dhis.mobile:designsystem:0.3.0")
}
```

# Usage

```kotlin
setContent {
DHIS2Theme {
// A surface container using the 'background' color from the theme
Surface(
modifier = Modifier.fillMaxSize(),
color = SurfaceColor.Container
) {
Components()
}
}
}
```

```kotlin
Button(
text = provideStringResource("show_more"),
icon = {
Icon(
painter = provideDHIS2Icon(resourceName = "dhis2_blood_a_n_positive"),
contentDescription = ""
)
},
style = ButtonStyle.KEYBOARDKEY
) {}
```
Dhis2 Mobile UI library documentation, installation and usage is explained in [DHIS2 Developer portal](https://developers.dhis2.org/mobile/mobile-ui/overview)

## Compose Compiler Reports

Expand Down

0 comments on commit 7df54d8

Please sign in to comment.