This library provides a set of Settings like composable items to help android Jetpack Compose developers build complex settings screens without all the boilerplate
allprojects {
repositories {
//...
mavenCentral()
}
}
Add dependencies:
implementation 'com.github.alorma:compose-settings-ui:$version'
Menu link | Switch | Checkbox |
---|---|---|
![]() |
![]() |
![]() |
This library provide some @Composable
items that can be used to build your settings screen.
Scaffold
, Column
... is not provided by the library, you can place items wherever you want.
This can be used to open another settings screen, open link, show a dialog...
SettingsMenuLink(
icon = { Icon(imageVector = Icons.Default.Wifi, contentDescription = "Wifi") },
title = { Text(text = "Hello") },
subtitle = { Text(text = "This is a longer text") },
onClick = {},
)
action
can be provided:
SettingsMenuLink(
title = { Text(text = "Menu 4") },
action = { ... },
)
This can be used to enable or disable a feature
SettingsCheckbox(
icon = { Icon(imageVector = Icons.Default.Wifi, contentDescription = "Wifi") },
title = { Text(text = "Hello") },
subtitle = { Text(text = "This is a longer text") },
onCheckedChange = { newValue -> },
)
SettingsCheckbox(
icon = { Icon(imageVector = Icons.Default.Wifi, contentDescription = "Wifi") },
title = { Text(text = "Hello") },
subtitle = { Text(text = "This is a longer text") },
onCheckedChange = { newValue -> },
)
In order to provide a default value for the setting and recompose when state changes, you must use state
parameter.
implementation 'com.github.alorma:compose-settings-storage-preferences:$version'
val state = rememberBooleanSettingState()
SettingsCheckbox(state = state)
val state = rememberFloatSettingState()
SettingSlider(state = state)
And, you can react to state change, for example:
val state = rememberBooleanSettingState()
if (state.value) {
Text("Enabled")
} else {
Text("Disabled")
}
val state = rememberBooleanSettingState()
if (state.value > 0.5f) {
Icon(imageVector = Icons.Default.BrightnessLow)
} else {
Icon(imageVector = Icons.Default.BrightnessHigh)
}
This library provide default value for state as false
, however if you need to pass a different value (true
), you can use:
val state = rememberBooleanSettingState(defaultValue = true)
val state = rememberFloatSettingState(defaultValue = 0.1f)
The library provides a preferences version of the state, so when setting state is changed, the value is persisted on the preferences.
val state = rememberPreferenceBooleanSettingState(key = "pref_key", defaultValue = true)
val state = rememberPreferenceFloatSettingState(key = "pref_key", defaultValue = 0.1f)
val state = rememberPreferenceIntSettingState(key = "pref_key", defaultValue = 1)
Also, the library provides a DataStore version of the state, so when setting state is changed, the value is persisted on the DataStore preferences.
val state = rememberDataStoreBooleanSettingState(key = "pref_key", defaultValue = true)
val state = rememberDataStoreFloatSettingState(key = "pref_key", defaultValue = 0.1f)
val state = rememberDataStoreIntSettingState(key = "pref_key", defaultValue = 1)