Skip to content

Moriafly/SaltUI

Repository files navigation

stableMaven Central CodeFactor

Salt UI

Salt UI is UI components based on Compose Multiplatform. The 1.0 version is derived from some UI components of Salt Player. Currently, Salt UI is used in Salt Player, Emo Scroll, Qinalt and other App to serve hundreds of thousands of users.

Compatibility

Salt UI Compose Multiplatform Jetpack Compose
2.8.0-alpha01+ 1.10.0-alpha02 1.10.0-alpha04
2.7.0-alpha01+ 1.10.0-alpha01 1.10.0-alpha02
2.6.0-beta02+ 1.9.0-rc01 1.9.0
2.6.0-beta01+ 1.9.0-beta03 1.9.0-rc01
2.5.0-alpha05+ 1.8.2 1.8.2
2.4.0+ 1.8.0 1.8.0
2.3.1+ 1.7.3 1.7.6
2.3.0-alpha02+ 1.7.1 1.7.5
2.2.0+ 1.7.0 1.7.1
2.2.0-beta01+ 1.7.0-rc01 1.7.0
2.2.0-alpha01+ 1.7.0-beta02
2.0.7+ 1.7.0-alpha03
2.0.4+ 1.7.0-alpha02
< 2.0.4 1.6.11

Get started

Add dependency:

// Replace <TAG> with the latest version
// e.g. implementation("io.github.moriafly:salt-ui:2.6.0-beta02")
implementation("io.github.moriafly:salt-ui:<TAG>")

Simple start:

@Composable
fun App() {
    SaltTheme(
        configs = saltConfigs()
    ) {
        // ...
    }
}

See demo: composeApp.

Text Description and Translation Standards

See: Salt UI Text Description and Translation Standards.

Google Play

Salt UI performs operations related to internal ART APIs. Please refer to the following solution for publishing on the Google Play platform.

Google Play doesn't allow apps to use hidden APIs, reporting library usage will cause your app to fail app review, you need to disable dependencies info reporting in build.gradle. Remember to update this library to latest version to be compatible with new Android version.

Quoted from AndroidHiddenApiBypass

 android {
     dependenciesInfo {
         includeInApk = false
         includeInBundle = false
     }
 }

License

See LICENSE.

Contribute

See Contributor Covenant Code of Conduct.

Thanks