ComposePreferences

3.0.0indexed

Enables intuitive management of app preferences using a modern UI toolkit, streamlining shared preferences and datastore integration with customizable, dynamic UI components.

AndroidJVMNativeWasm·MFlisar/ComposePreferences

Stars

Used by

dependents

—

Health

/ 100

ComposePreferences

This library offers you an easily extendible compose framework for preferences.

[!NOTE] All features are splitted into separate modules, just include the modules you want to use!

Screenshots

:camera: Screenshots

bool

button

color

core

date

input

list

number

time

:computer: Supported Platforms

:arrow_right: Versions

Dependency	Version
Kotlin	`2.4.0`
Jetbrains Compose	`1.11.1`

:warning: Following experimental annotations are used:

OptIn

androidx.compose.ui.ExperimentalComposeUiApi (1x)

I try to use as less experimental features as possible, but in this case the ones above are needed!

:wrench: Setup

:rocket: Usage

Basic example

// select a style for your preferences
val style = DefaultStyle.create()
val modernStyle = ModernStyle.create()

// create a preference settings instance (you can adjust a few additional settings here)
val settings = PreferenceSettingsDefaults.settings(
    style = style
)

// create a state for the preference screen (this is optional - only needed if you need access to informations from this state)
val state = rememberPreferenceState()

// create a preference screen
PreferenceScreen(
    modifier = Modifier,
    settings = settings,
    state = state
) {
    // preference items
    // ...
}

Preference items

Check out the modules region in the menu on the left to find out more about the different preference items.

Here's a very basic example to show you how the preference items are used inside the PreferenceScreen:

PreferenceScreen(
    // ...
) {
    PreferenceSection(
        title = "Section 1"
    ) {
        PreferenceInfo(
            title = "Info 1"
        )
        val checked = remember { mutableStateOf(false) }
        PreferenceBool(
            value = checked,
            title = "Boolean Preference"
        )
        val input =  remember { mutableStateOf("") }
        PreferenceInputText(
            value = input,
            title = "Input Preference"
        )
    }
    PreferenceSection(
        title = "Section 2"
    ) {
        PreferenceInfo(
            title = "Info 2"
        )
    }
}

:file_folder: Modules

:sparkles: Demo

A full demo is included inside the demo module, it shows nearly every usage with working examples.

:information_source: More

Advanced
Migration

:books: API

Check out the API documentation.

:bulb: Other Libraries

You can find more libraries (all multiplatform) of mine that all do work together nicely here.

Related libraries

Surfaced from shared tags and platforms — no rankings paid for.

ComposeDialogs★ 91

MFlisarEnhances user interfaces with customizable dialogs, offering flexible configurations and seamless integration for simplified dialog management and user interaction.Shared: material3, design-system, compose

ComposeDebugDrawer★ 44

MFlisarEnhances UI development with a customizable debug drawer, allowing easy integration of debugging features into applications to streamline testing and troubleshooting processes.Shared: material3, compose, android-ui

compose★ 6.0k

androidxDeclarative UI toolkit enabling programmatic UI via composable functions, offering animations, Material (including Material 3), foundation building blocks, compiler optimizations, runtime state management, and core UI primitives.Shared: material3, compose, android-ui

JetCo★ 375

developerchunkReady-to-use, customizable Compose UI components — charts, cards, steppers, controls — offering polished visuals, interactive behaviors, performance optimizations, and easy integration into declarative UI projects.Shared: design-system, compose, android-ui

material3-windowsizeclass-multiplatform★ 361

chrisbanesFacilitates responsive UI design by implementing Material 3 window size classes across multiple platforms, ensuring layouts adapt to various screen sizes. Supports Android, iOS, desktop, and web environments.Shared: material3, compose, android-ui

ComposePreference★ 315

zhanghaiImplements a preference system with Material 3 design for Jetpack Compose, offering various preference types, theming options, and customizable data sources for flexible and efficient UI development.Shared: preferences, compose, android-ui

Dependency

Version

Kotlin

2.4.0

Jetbrains Compose

1.11.1

:rocket: Usage

Basic example

// select a style for your preferences val style = DefaultStyle.create() val modernStyle = ModernStyle.create() // create a preference settings instance (you can adjust a few additional settings here) val settings = PreferenceSettingsDefaults.settings( style = style ) // create a state for the preference screen (this is optional - only needed if you need access to informations from this state) val state = rememberPreferenceState() // create a preference screen PreferenceScreen( modifier = Modifier, settings = settings, state = state ) { // preference items // ... }

Preference items

Check out the modules region in the menu on the left to find out more about the different preference items.

Here's a very basic example to show you how the preference items are used inside the PreferenceScreen:

PreferenceScreen( // ... ) { PreferenceSection( title = "Section 1" ) { PreferenceInfo( title = "Info 1" ) val checked = remember { mutableStateOf(false) } PreferenceBool( value = checked, title = "Boolean Preference" ) val input = remember { mutableStateOf("") } PreferenceInputText( value = input, title = "Input Preference" ) } PreferenceSection( title = "Section 2" ) { PreferenceInfo( title = "Info 2" ) } }

core	✅	✅	✅	✅	provides all the basic preference classes and composables
screen-bool	✅	✅	✅	✅	provides a checkbox/switch preference screen
screen-button	✅	✅	✅	✅	provides a button preference screen
screen-color	✅	✅	✅	✅	provides a color picker preference screen
screen-date	✅	✅	✅	✅	provides a date picker preference screen
screen-input	✅	✅	✅	✅	provides a input dialog preference screen
screen-list	✅	✅	✅	✅	provides a list dialog preference screen
screen-number	✅	✅	✅	✅	provides a number picker preference screen
screen-time	✅	✅	✅	✅	provides a time picker preference screen
kotpreferences	✅	✅	✅	✅	provides extensions to use KotPreferences with ComposePreferences

ComposePreferences

ComposePreferences

Table of Contents

:camera: Screenshots