/admiralui-android

Admiral UIKit Android

Primary LanguageKotlin

Admiral UI Kit version

Visual components library for Android

What is AdmiralUI?

AdmiralUI - is a ready-made set of user interface elements.

Components overview:

To learn more about the status of the AdmiralUI design system components and their names in the code, please follow this link

Pros of using UI Kit:

  • Allows you to adhere to a single visual style and interface solutions
  • Speeds up prototyping
  • Saves time for designers and developers

Why Admiral UI Kit?

  • 💎 Lots of components - 30+ components based on Android View from buttons and text fields to timepicker and calendar. Components based on Compose are under development.
  • 🛠 Customizable - components have many customizable properties.
  • 🎨 Theming - support for different color palettes, the ability to create your own and instantly switch between them.
  • 🏗 Maintained - releases come out every two weeks.
  • 📱 Single style across platforms - there is a library for iOS
  • 📄 License - TODO..

Demo app

A live example of using the Admiral UI Kit library is our demo application. With it, you can evaluate all the components implemented in the library in different states, with the ability to switch built-in color themes and create your own.

Run demo app

  • Clone the git@github.com:admiral-team/admiralui-android.git repository
  • Switch to the main branch
  • In Android Studio, run the demo on an emulator or on a real device

Language and API version

  • Main development language Kotlin
  • Minimum supported Android version: API 21

Download

There are two ways to include the library: GitHubPackages and MavenLocal. Read details in the wiki.

Using components

Adding a button component

<com.admiral.uikit.components.button.Button
   android:id="@+id/btnPrimaryBig"
   android:layout_width="match_parent"
   android:layout_height="wrap_content"
   android:text="Big primary button"
   app:admiralButtonSize="big"
   app:admiralButtonStyle="primary" />

Examples of using all other components can be found in the source application demo.

See the readme for more instructions on using components.

Generation of documentation

All public methods and classes are documented. You can also generate code documentation using the Dokka plugin.

Contributors

We welcome any help, and you can help us with the development of this project. Details in the wiki.

Project team


Anton Polyakov

👑

Timur Badretdinov

💻

Semyon Babakaev

💻

Evgeny Krutsky

🛠