https://github.com/brianwernick/datastoredelegates

Property Delegation for the AndroidX DataStore
https://github.com/brianwernick/datastoredelegates

Last synced: about 2 months ago
JSON representation

Property Delegation for the AndroidX DataStore

• Host: GitHub
• URL: https://github.com/brianwernick/datastoredelegates
• Owner: brianwernick
• License: apache-2.0
• Created: 2023-06-12T18:48:57.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-11-28T17:30:54.000Z (about 1 year ago)
• Last Synced: 2024-04-17T23:53:08.224Z (9 months ago)
• Language: Kotlin
• Size: 133 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Maven Central](https://img.shields.io/maven-central/v/com.devbrackets.android/datastore)

DataStore Delegates

============

Property delegation and extensions for Android's `DataStore`s, including:

* Read/Write variable delegation

* Flow and SharedFlow extensions

* Preference type conversions

Use

-------

The latest version can be found at [Maven Central][MavenCentral].

```gradle

repositories {

  mavenCentral()

}

dependencies {

  implementation 'com.devbrackets.android:datastore:1.0.0-preview01'

}

```

Quick Start

-------

```kotlin

// Supported Preference type

var userColor by dataStore.value("userColor", "0xFFFFFF")

val userColorFlow = dataStore.flow("userColor", "0xFFFFFF")

// Preference with conversion

var userColor by dataStore.value("userColor", Color.valueOf(0xFFFFFFFF), ColorValueConverter())

val userColorFlow = dataStore.flow("userColor", Color.valueOf(0xFFFFFFFF), ColorValueConverter())

```

License

-------

    Copyright 2023 DataStore Delegates Contributors

    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.

Attribution

-----------

* Uses [Kotlin](https://kotlinlang.org/) licensed under [Apache 2.0][Apache 2.0]

* Uses [DataStore](https://developer.android.com/jetpack/androidx/releases/datastore) licensed under [Apache 2.0][Apache 2.0]

 [Apache 2.0]: http://www.apache.org/licenses/LICENSE-2.0

 [MavenCentral]: https://central.sonatype.com/artifact/com.devbrackets.android/datastore