Skip to content

ch4rl3x/settings-compose

Repository files navigation

settings-compose

Current Compose Version: 1.1.0

Build CodeFactor Maven Central

Add to your project

Add actual settings-compose library:

dependencies {
    implementation 'de.charlex.compose:settings-datastore:2.0.0'
}

How does it work?

Provide the SettingsDataStore

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    ...
    setContent {
        //Provide SettingsDataStore around
        CompositionLocalProvider(LocalSettingsDataStore provides settingsDataStore) {
            ...
        }
    }
}

Use one of the following ways

SettingsContext

Setting(
    key = booleanPreference("key1", false)
) { value, onValueChange ->
    Switch(
        checked = value,
        onCheckedChange = onValueChanged
    )
}

rememberSettingsValue

val (value, onValueChange) = rememberSettingsValue(key = booleanPreference("key2", false))
Checkbox(checked = value, onCheckedChange = onValueChange)

That's it!

License

Copyright 2022 Alexander Karkossa

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.