Ui-Material3

Setup

Add the dependency to your project

build.gradle.kts

dependencies {
    implementation("com.geekorum.aboutoss:ui-material3:<latest-version>")
}

Usage

The OpenSourceDependenciesNavHost composable allows to display the licenses. It takes an OpenSourceLicensesViewModel that you can create with the LicenseInfoRepository of your choice.

val licenseInfoRepository = LicenseeLicenseInfoRepository()
val viewModel = viewModel<OpenSourceLicensesViewModel>(factory = OpenSourceLicensesViewModel.Factory(licenseInfoRepository))
OpenSourceDependenciesNavHost(
    openSourceLicensesViewModel = viewModel,
    navigateUp = {
        // close screen
    }
)

The AdaptiveOpenSourceDependenciesScreen composable display the licenses in an adaptive screen. The User interface will adapt based on the available space.

val licenseInfoRepository = LicenseeLicenseInfoRepository()
val viewModel = viewModel<OpenSourceLicensesViewModel>(factory = OpenSourceLicensesViewModel.Factory(licenseInfoRepository))
AdaptiveOpenSourceDependenciesScreen(
    openSourceLicensesViewModel = viewModel,
    navigateUp = {
        // close screen
    }
)

Android

The OpenSourceLicensesActivity is configured to work with the OSS Licenses Gradle Plugin You can launch the activity like this:

val intent = Intent(this, OpenSourceLicensesActivity::class.java)
startActivity(intent)

Desktop

On Desktop the OpenSourceLicensesWindow is configured to work with licensee. You can use it like this:

OpenSourceLicensesWindow(onCloseRequest = {
    // close window
})