docs/ui-material.md
author Da Risk <da_risk@geekorum.com>
Sat, 01 Nov 2025 00:27:00 -0400
changeset 112 b2032db61006
parent 97 20ba708adda9
permissions -rw-r--r--
build: update project version to 0.2.2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
97
20ba708adda9 soft deprecate ui-material
Da Risk <da_risk@geekorum.com>
parents: 84
diff changeset
     1
Ui-Material (Deprecated)
20ba708adda9 soft deprecate ui-material
Da Risk <da_risk@geekorum.com>
parents: 84
diff changeset
     2
========================
20ba708adda9 soft deprecate ui-material
Da Risk <da_risk@geekorum.com>
parents: 84
diff changeset
     3
20ba708adda9 soft deprecate ui-material
Da Risk <da_risk@geekorum.com>
parents: 84
diff changeset
     4
The Material user interface will not receive further updates and is now deprecated.
20ba708adda9 soft deprecate ui-material
Da Risk <da_risk@geekorum.com>
parents: 84
diff changeset
     5
Consider using [ui-material3](ui-material3.md) instead.
84
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     6
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     7
Setup
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     8
=====
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     9
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    10
Add the dependency to your project
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    11
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    12
```kotlin title="build.gradle.kts"
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    13
dependencies {
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    14
    implementation("com.geekorum.aboutoss:ui-material:<latest-version>")
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    15
}
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    16
```
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    17
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    18
Usage
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    19
=====
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    20
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    21
The [OpenSourceDependenciesNavHost](api/ui/material2/com.geekorum.aboutoss.ui.material/-open-source-dependencies-nav-host.html)
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    22
composable allows to display the licenses. 
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    23
It takes an [OpenSourceLicensesViewModel](api/ui/common/com.geekorum.aboutoss.ui.common/-open-source-licenses-view-model/index.html)
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    24
that you can create with the [LicenseInfoRepository](license-sources.md) of your choice.
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    25
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    26
```kotlin
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    27
val licenseInfoRepository = LicenseeLicenseInfoRepository()
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    28
val viewModel = viewModel<OpenSourceLicensesViewModel>(factory = OpenSourceLicensesViewModel.Factory(licenseInfoRepository))
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    29
OpenSourceDependenciesNavHost(
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    30
    openSourceLicensesViewModel = viewModel,
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    31
    navigateUp = {
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    32
        // close screen
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    33
    }
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    34
)
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    35
```
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    36
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    37
Android
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    38
=======
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    39
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    40
The [OpenSourceLicensesActivity](api/ui/material2/com.geekorum.aboutoss.ui.material/-open-source-licenses-activity/index.html) is configured to work with the [OSS Licenses Gradle Plugin](https://github.com/google/play-services-plugins/tree/main/oss-licenses-plugin)
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    41
You can launch the activity like this:
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    42
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    43
```kotlin
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    44
val intent = Intent(this, OpenSourceLicensesActivity::class.java)
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    45
startActivity(intent)
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    46
```
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    47
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    48
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    49
Desktop
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    50
=======
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    51
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    52
On Desktop the [OpenSourceLicensesWindow](api/ui/material2/com.geekorum.aboutoss.ui.material/-open-source-licenses-window.html) is configured to work with [licensee](https://github.com/cashapp/licensee).
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    53
You can use it like this:
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    54
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    55
```kotlin
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    56
OpenSourceLicensesWindow(onCloseRequest = {
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    57
    // close window
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    58
})
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    59
```
f1e51fe391c2 docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    60