Git Product home page Git Product logo

flowpref's Introduction

DEPRECATED

I recommend to use Jetpack Datastore instead.

FlowPref

FlowPref is a library for making Preferences composable, typesafe and reactive (by exposing a kotlin Flow).

Usage

// create a flow pref backed by shared preferences
val sharedPrefs = context.getSharedPreferences("prefName", Context.MODE_PRIVATE)
// ensure this is a singleton across process
val prefs = AndroidPreferences(sharedPrefs)

val intPref = prefs.int("prefKey", 42)

// write and get values
intPref.value = 5
println(intPref.value)

// flow
scope.launch {
  intPref.flow.collect { 
    println(it)
  }
}

// use it as a property
var myValue by intPref
myValue = 5
println(myValue)

Setup

Add jitpack to your repositories:

allprojects {
    repositories {
        ...
        maven { url "https://jitpack.io" }
    }
}

And add the dependency:

dependencies {
    // android implementation
    implementation 'com.github.PaulWoitaschek.FlowPref:android:x.y.z'
    
    // core only, useful for consuming kotlin-only modules
    implementation 'com.github.PaulWoitaschek.FlowPref:core:x.y.z'

    // an in-memory implementation, useful for testing. Pure kotlin
    implementation 'com.github.PaulWoitaschek.FlowPref:in-memory:x.y.z'
}

flowpref's People

Contributors

paulwoitaschek avatar renovate[bot] avatar marionoll avatar

Stargazers

Paul avatar

Watchers

 avatar James Cloos avatar  avatar

Forkers

mjureczko

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.