Code Monkey home page Code Monkey logo

materialthemeprefs's Introduction

Material Theme Preferences

Maven Central Build & Publish CI/CD

Kotlin Multiplatform library for easy switching Dark/Light Material themes on Compose. Supported platforms:

  • Android
  • iOS
  • Desktop JVM (MacOS, Linux, Windows)

Android screenshot Desktop screenshot

Usage

Call composable functions for material theme wrap, preferences items on settings screen, showing dialog for select theme.

@Composable
fun App() = PreferableMaterialTheme { // provides composition locals
    SettingsScaffold { // includes TopAppBar
        Box {
            Column {
                ThemePreferencesCategory() // subtitle
                ThemePreferenceItem() // menu item
            }
            themePrefs.showDialogIfNeed() // shows when menu item clicked
        }
    }
}

The NoteDelight app is a real example.

Installation

The latest release is available on Maven Central.

Gradle

  1. Add the Maven Central repository if it is not already there:
repositories {
    mavenCentral()
}
  1. In multiplatform projects, add a dependency to the commonMain source set dependencies
commonMain {
    dependencies {
        implementation("io.github.softartdev:theme-material:$latestVersion") // Material Design 2
        implementation("io.github.softartdev:theme-material3:$latestVersion") // Material Design 3
        implementation("io.github.softartdev:theme-prefs:$latestVersion") // optional, if you need only preferences
    }
}

Implementation

Used moko-resources library for many languages (currently Russian and English are supported).

Persisting preferences is implemented using SharedPreferences on Android, and Java Preference API on JVM Desktop.

// common:
expect var themeEnum: ThemeEnum

// android:
private val preferences: SharedPreferences = PreferenceManager.getDefaultSharedPreferences(context)

actual var themeEnum: ThemeEnum
    get() = preferences.getInt(THEME_KEY, ThemeEnum.SystemDefault.ordinal).let(ThemeEnum.values()::get)
    set(value) = preferences.edit().putInt(THEME_KEY, value.ordinal).apply()

// desktop java:
private var preferences: Preferences = Preferences.userNodeForPackage(ThemeEnum::class.java)

actual var themeEnum: ThemeEnum
    get() = preferences.getInt(THEME_KEY, ThemeEnum.SystemDefault.ordinal).let(ThemeEnum.values()::get)
    set(value) = preferences.putInt(THEME_KEY, value.ordinal)

Also used composition local for access from theme-scoped as an implicit way:

val themePrefs: ThemePrefs = LocalThemePrefs.current

materialthemeprefs's People

Contributors

softartdev avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.