Skip to content

Commit

Permalink
Merge pull request #313 from dhis2/update-dev-info-and-figma-link-docs
Browse files Browse the repository at this point in the history
Improve dev documentation, refresh Figma library link, and document Java and XML compatibility
  • Loading branch information
vgarciabnz authored Oct 8, 2024
2 parents 1b3c138 + 0f59819 commit 1d72230
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
5 changes: 3 additions & 2 deletions docs/design-system.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 4

# Design System

The **DHIS2 Mobile UI Library** is built upon the [DHIS2 Mobile Design System Figma library](https://www.figma.com/file/eRk6bt0B8BJlTO9PZXirHN/DHIS2-Mobile-Design-System). This design system offers a comprehensive set of guidelines, components, and best practices to ensure consistency and enhance user experience across all DHIS2 mobile applications.
The **DHIS2 Mobile UI Library** is built upon the [DHIS2 Mobile Design System Figma library](https://www.figma.com/community/file/1423970586603523207/dhis2-mobile-design-system). This design system offers a comprehensive set of guidelines, components, and best practices to ensure consistency and enhance user experience across all DHIS2 mobile applications.

![](resources/design-system.png)

Expand Down Expand Up @@ -52,7 +52,8 @@ The design system encompasses a wide array of elements that contribute to a cohe

To incorporate the DHIS2 Mobile Design System into your project:

1. **Explore the Figma Library**: Familiarize yourself with the available components and styles by accessing the [Figma library](https://www.figma.com/file/eRk6bt0B8BJlTO9PZXirHN/DHIS2-Mobile-Design-System).
1. **Explore the Figma Library**: Familiarize yourself with the available components and styles by accessing the [Figma library](https://www.figma.com/community/file/1423970586603523207/dhis2-mobile-design-system).
2. **Use the Figma Library for Mock-ups and Prototypes**: Before starting development, you can utilize the Figma library to create mock-ups and prototypes. This allows you to visualize the app's design and functionality, facilitating better planning and collaboration among team members.
2. **Follow the Guidelines**: Apply the design principles and component guidelines to ensure a consistent and user-friendly interface.
3. **Maintain Accessibility**: Ensure all design elements meet accessibility standards for color contrast, font sizes, and interactive elements.
4. **Collaborate and Contribute**: Share feedback, suggest improvements, or contribute new components to help evolve the design system.
Expand Down
9 changes: 7 additions & 2 deletions docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,15 @@ This library currently supports **desktop** and **Android** targets, in the next
support **iOS**.

### Android

**DHIS2 Mobile UI library** provides native support for Android. When targeting Android, you can
leverage the full power of Jetpack Compose, Google's modern UI toolkit for Android. The Compose
Multiplatform library seamlessly integrates with Android Studio and the Android build system.
Multiplatform library seamlessly integrates with Android Studio and the Android build system.
However, if your project uses Java and XML layouts, you can still integrate the library by embedding Compose
components within your existing views.

#### Using with Java and XML

If your project uses Java and XML layouts, you can still integrate the library by embedding Compose components within your existing views. For guidance on interoperability between XML and Compose, refer to the [Android Developers Interoperability Guide](https://developer.android.com/develop/ui/compose/migrate/interoperability-apis).

### Desktop

Expand Down

0 comments on commit 1d72230

Please sign in to comment.