/oneui-compose

Enables Jetpack Compose developers the ability to incorporate Samsung's OneUI design-system into their applications, to match the visuals of prebuilt Samsung apps.

Primary LanguageKotlinApache License 2.0Apache-2.0

OneUI Library for Jetpack compose

This is a library for Jetpack Compose which aims at enabling developers to use Samsung's OneUI Design.

Note

While this library does aim at replicating the look of the OneUI Design, it is to note that this will never be truly achieved, due to the closed-source nature of the Samsung apps. Still, by decompiling those, we can scrape core information about the apps, such as color, dimension and translation values, from the apps res folder. While this is tedious and sometimes impossible due to code obfuscation, the team at the OneUI Library for Android XML has done a big part of this work, making a great contribution towards this project.

Work in Progress

This library is still, as of October 14 2023, work in progress.

Future aims include but are not limited to:

  • Markup documentation for every component with preview images
  • Support for dynamic theming (OneUI-capable devices only)
  • Color Picker dialog

Further problems are noted as TODO-comments at the core composable of a component.

Getting started

Please refer to getting started

Contributing

Please refer to the contributing-guide

Design Library

This library is only a design library, meaning only visuals, no implementation is provided. Meaning for example, the technical implementation for the preference components of storing a users preferences must be implemented by each app itself. This may change in the future, although currently this is no big priority.

Credits