Setup

📋 Requirements #

• minSdk: 23 or higher
• AGP (Android Gradle Plugin): version 8.2.1 or higher
• compileSdk: 34 or higher

🚀 Getting Started #

1. Add Repository: Ensure you have the Design System repository added to your project’s settings.gradle file.

repositories {
  maven {
    url = uri(path = "https://maven.pkg.github.com/YAtechnologies/ux-sefar-android")
    credentials {
      username = System.getenv("GITHUB_USER")
      password = System.getenv("GITHUB_TOKEN")
    }
  }
}

2. Enable desugaring: Update your build.gradle file if necessary.

android {
  compileOptions {
    isCoreLibraryDesugaringEnabled = true
  }
}

dependencies {
  coreLibraryDesugaring("com.android.tools:desugar_jdk_libs:2.0.3")
}

Check out the documentation for more details -> LINK

3. Add Dependency: Include the Design System dependency in your module’s build.gradle file. Or if you are using a newer Gradle configuration, then add it to settings.gradle

implementation("com.yassir.ux:design-system:{latest stable package version}")

Usage #

Replace

setContentView(R.layout. ...)

with

setContent {
   YassirTheme {
     ....
   }
}

Start consuming the DS library

ex:

YassirTheme.spacing.spacing2

Icons are separated in multiple libraries according to there usage. For example if you need to load the Maps library you will need to implement its library ex:

implementation "com.yassir.ux:icons-maps:{latest stable package version}"

To consume the previous example icon library

ex.: MapsIcons.Map
Image(painter = painterResource(id = MapsIcons.Map), contentDescription = "")