├── .gitignore ├── .idea └── codeStyles │ ├── Project.xml │ └── codeStyleConfig.xml ├── LICENSE.md ├── README.md ├── build.gradle ├── gradle.properties ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── jitpack.yml ├── lib ├── .gitignore ├── build.gradle ├── consumer-rules.pro ├── maven-publishing.gradle ├── proguard-rules.pro └── src │ ├── androidTest │ └── java │ │ └── dev │ │ └── burnoo │ │ └── compose │ │ └── rememberpreference │ │ ├── AdvancedRememberPreferenceTest.kt │ │ ├── RememberBooleanPreferenceTest.kt │ │ ├── RememberDoublePreferenceTest.kt │ │ ├── RememberFloatPreferenceTest.kt │ │ ├── RememberIntPreferenceTest.kt │ │ ├── RememberLongPreferenceTest.kt │ │ ├── RememberStringPreferenceTest.kt │ │ └── RememberStringSetPreferenceTest.kt │ └── main │ ├── AndroidManifest.xml │ └── java │ └── dev │ └── burnoo │ └── compose │ └── rememberpreference │ └── RememberPreference.kt ├── sample ├── build.gradle ├── proguard-rules.pro └── src │ └── main │ ├── AndroidManifest.xml │ ├── java │ └── dev │ │ └── burnoo │ │ └── compose │ │ └── rememberpreference │ │ └── sample │ │ ├── AllExample.kt │ │ ├── MainActivity.kt │ │ ├── NullabilityExample.kt │ │ ├── OnboardingExample.kt │ │ └── ui │ │ └── theme │ │ ├── Color.kt │ │ ├── Shape.kt │ │ ├── Theme.kt │ │ └── Type.kt │ └── res │ ├── drawable-v24 │ └── ic_launcher_foreground.xml │ ├── drawable │ └── ic_launcher_background.xml │ ├── mipmap-anydpi-v26 │ ├── ic_launcher.xml │ └── ic_launcher_round.xml │ ├── mipmap-hdpi │ ├── ic_launcher.webp │ └── ic_launcher_round.webp │ ├── mipmap-mdpi │ ├── ic_launcher.webp │ └── ic_launcher_round.webp │ ├── mipmap-xhdpi │ ├── ic_launcher.webp │ └── ic_launcher_round.webp │ ├── mipmap-xxhdpi │ ├── ic_launcher.webp │ └── ic_launcher_round.webp │ ├── mipmap-xxxhdpi │ ├── ic_launcher.webp │ └── ic_launcher_round.webp │ ├── values-night │ └── themes.xml │ └── values │ ├── colors.xml │ ├── strings.xml │ └── themes.xml └── settings.gradle /.gitignore: -------------------------------------------------------------------------------- 1 | # Gradle files 2 | .gradle/ 3 | build/ 4 | 5 | # Local configuration file (sdk path, etc) 6 | local.properties 7 | 8 | # Log Files 9 | *.log 10 | 11 | # Android Studio captures folder 12 | captures/ 13 | 14 | # Intellij 15 | *.iml 16 | .idea/**/* 17 | !.idea/codeStyles 18 | !.idea/codeStyles/* 19 | 20 | # MacOS folder properties 21 | *.DS_STORE -------------------------------------------------------------------------------- /.idea/codeStyles/Project.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 7 | 8 | 120 | 121 | 123 | 124 | -------------------------------------------------------------------------------- /.idea/codeStyles/codeStyleConfig.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # compose-remember-preference 2 | [![Maven Central](https://img.shields.io/maven-central/v/dev.burnoo/compose-remember-preference)](https://search.maven.org/search?q=dev.burnoo.compose-remember-preference) 3 | 4 | Jetpack Compose library for remembering state persistently, based on DataStore preferences. Basically it's persistent version of `remember { mutableStateOf(x) }`. 5 | 6 | ## Getting started 7 | Library is distributed through Maven Central. To use it you need to add following dependancy to your module `build.gradle`: 8 | ```groovy 9 | dependencies { 10 | implementation 'dev.burnoo:compose-remember-preference:1.1.1' 11 | } 12 | ``` 13 | To store state in `@Composable` when app is running you would use `remember { mutableStateOf(x) }`. The library comes with the same functionality, but supports data persistence, saving and restoring data using DataStore preferences. It has it owns functions that returns `MutableState`. 14 | ```kotlin 15 | @Composable 16 | fun Component() { 17 | var string by rememberStringPreference(keyName = "stringKey") 18 | var int by rememberIntPreference(keyName = "intKey", defaultValue = 0) 19 | var boolean by rememberBooleanPreference( 20 | keyName = "booleanKey", initialValue = false, defaultValue = false 21 | ) 22 | } 23 | ``` 24 | Each function has additional value parameters, which can be used for handling all possible states: 25 | ```kotlin 26 | @Composable 27 | fun OnboardingExample() { 28 | var isOnboardingCompleted by rememberBooleanPreference( 29 | keyName = "onboardingKey", // preference is stored using this key 30 | initialValue = null, // returned before preference is loaded 31 | defaultValue = false, // returned when preference is not set yet 32 | ) 33 | when (isOnboardingCompleted) { 34 | null -> Loader() 35 | false -> Onboarding(onCompleted = { isOnboardingCompleted = true }) 36 | true -> MainScreen() 37 | } 38 | } 39 | ``` 40 | 41 | ## Demo ([source](https://github.com/burnoo/compose-remember-preference/blob/master/sample/src/main/java/dev/burnoo/compose/rememberpreference/sample/MainActivity.kt)) 42 | ![demo](https://user-images.githubusercontent.com/17478192/110863632-430a9c80-82c1-11eb-9381-cc415f3fa505.gif) 43 | 44 | ## Supported types 45 | (the same as DataStore preferences) 46 | - `String` - `rememberStringPreference` 47 | - `Int` - `rememberIntPreference` 48 | - `Boolean` - `rememberBooleanPreference` 49 | - `Float` - `rememberFloatPreference` 50 | - `Double` - `rememberDoublePreference` 51 | - `Long` - `rememberLongPreference` 52 | - `String` - `rememberStringSetPreference` 53 | 54 | ## Nullability 55 | Each function has two versions - nullable and non nullable. When `initailValue` and `defaultValue` are non nullable it returns `MutableState` otherwise `MutableState`: 56 | - `(keyName: String, initialValue: T, defaultValue: T) -> MutableState` 57 | - `(keyName: String, initialValue: T? = null, defaultValue: T? = null) -> MutableState` 58 | ```kotlin 59 | @Composable 60 | fun NullabilityExample() { 61 | val nullableStringState: MutableState = rememberStringPreference( 62 | keyName = "keyS1", 63 | initialValue = null, // null is default 64 | defaultValue = null // null is default 65 | ) 66 | val stringState: MutableState = rememberStringPreference( 67 | keyName = "keyS2", 68 | initialValue = "Loading", 69 | defaultValue = "Default" 70 | ) 71 | } 72 | ``` 73 | 74 | ## License 75 | ``` 76 | Copyright 2020 Bruno Wieczorek 77 | 78 | Licensed under the Apache License, Version 2.0 (the "License"); 79 | you may not use this file except in compliance with the License. 80 | You may obtain a copy of the License at 81 | 82 | http://www.apache.org/licenses/LICENSE-2.0 83 | 84 | Unless required by applicable law or agreed to in writing, software 85 | distributed under the License is distributed on an "AS IS" BASIS, 86 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 87 | See the License for the specific language governing permissions and 88 | limitations under the License. 89 | ``` 90 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | buildscript { 2 | ext { 3 | lib_version = '1.1.1' 4 | compose_version = '1.7.8' 5 | datastore_version = '1.1.2' 6 | } 7 | repositories { 8 | google() 9 | mavenCentral() 10 | } 11 | dependencies { 12 | classpath 'com.android.tools.build:gradle:8.7.3' 13 | classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:2.1.10" 14 | } 15 | } 16 | 17 | plugins { 18 | id 'maven-publish' 19 | } 20 | 21 | tasks.register('clean', Delete) { 22 | delete rootProject.layout.buildDirectory 23 | } 24 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | # Project-wide Gradle settings. 2 | # IDE (e.g. Android Studio) users: 3 | # Gradle settings configured through the IDE *will override* 4 | # any settings specified in this file. 5 | # For more details on how to configure your build environment visit 6 | # http://www.gradle.org/docs/current/userguide/build_environment.html 7 | # Specifies the JVM arguments used for the daemon process. 8 | # The setting is particularly useful for tweaking memory settings. 9 | org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8 10 | # When configured, Gradle will run in incubating parallel mode. 11 | # This option should only be used with decoupled projects. More details, visit 12 | # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects 13 | # org.gradle.parallel=true 14 | # AndroidX package structure to make it clearer which packages are bundled with the 15 | # Android operating system, and which are packaged with your app"s APK 16 | # https://developer.android.com/topic/libraries/support-library/androidx-rn 17 | android.useAndroidX=true 18 | # Automatically convert third-party libraries to use AndroidX 19 | android.enableJetifier=true 20 | # Kotlin code style for this project: "official" or "obsolete": 21 | kotlin.code.style=official 22 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/burnoo/compose-remember-preference/8e5f0977143233e13f8511555cb97044b3db8cff/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.12.1-bin.zip 4 | networkTimeout=10000 5 | validateDistributionUrl=true 6 | zipStoreBase=GRADLE_USER_HOME 7 | zipStorePath=wrapper/dists 8 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | # 21 | # Gradle start up script for POSIX generated by Gradle. 22 | # 23 | # Important for running: 24 | # 25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 26 | # noncompliant, but you have some other compliant shell such as ksh or 27 | # bash, then to run this script, type that shell name before the whole 28 | # command line, like: 29 | # 30 | # ksh Gradle 31 | # 32 | # Busybox and similar reduced shells will NOT work, because this script 33 | # requires all of these POSIX shell features: 34 | # * functions; 35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 37 | # * compound commands having a testable exit status, especially «case»; 38 | # * various built-in commands including «command», «set», and «ulimit». 39 | # 40 | # Important for patching: 41 | # 42 | # (2) This script targets any POSIX shell, so it avoids extensions provided 43 | # by Bash, Ksh, etc; in particular arrays are avoided. 44 | # 45 | # The "traditional" practice of packing multiple parameters into a 46 | # space-separated string is a well documented source of bugs and security 47 | # problems, so this is (mostly) avoided, by progressively accumulating 48 | # options in "$@", and eventually passing that to Java. 49 | # 50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 52 | # see the in-line comments for details. 53 | # 54 | # There are tweaks for specific operating systems such as AIX, CygWin, 55 | # Darwin, MinGW, and NonStop. 56 | # 57 | # (3) This script is generated from the Groovy template 58 | # https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 59 | # within the Gradle project. 60 | # 61 | # You can find Gradle at https://github.com/gradle/gradle/. 62 | # 63 | ############################################################################## 64 | 65 | # Attempt to set APP_HOME 66 | 67 | # Resolve links: $0 may be a link 68 | app_path=$0 69 | 70 | # Need this for daisy-chained symlinks. 71 | while 72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 73 | [ -h "$app_path" ] 74 | do 75 | ls=$( ls -ld "$app_path" ) 76 | link=${ls#*' -> '} 77 | case $link in #( 78 | /*) app_path=$link ;; #( 79 | *) app_path=$APP_HOME$link ;; 80 | esac 81 | done 82 | 83 | # This is normally unused 84 | # shellcheck disable=SC2034 85 | APP_BASE_NAME=${0##*/} 86 | # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) 87 | APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit 88 | 89 | # Use the maximum available, or set MAX_FD != -1 to use that value. 90 | MAX_FD=maximum 91 | 92 | warn () { 93 | echo "$*" 94 | } >&2 95 | 96 | die () { 97 | echo 98 | echo "$*" 99 | echo 100 | exit 1 101 | } >&2 102 | 103 | # OS specific support (must be 'true' or 'false'). 104 | cygwin=false 105 | msys=false 106 | darwin=false 107 | nonstop=false 108 | case "$( uname )" in #( 109 | CYGWIN* ) cygwin=true ;; #( 110 | Darwin* ) darwin=true ;; #( 111 | MSYS* | MINGW* ) msys=true ;; #( 112 | NONSTOP* ) nonstop=true ;; 113 | esac 114 | 115 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 116 | 117 | 118 | # Determine the Java command to use to start the JVM. 119 | if [ -n "$JAVA_HOME" ] ; then 120 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 121 | # IBM's JDK on AIX uses strange locations for the executables 122 | JAVACMD=$JAVA_HOME/jre/sh/java 123 | else 124 | JAVACMD=$JAVA_HOME/bin/java 125 | fi 126 | if [ ! -x "$JAVACMD" ] ; then 127 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 128 | 129 | Please set the JAVA_HOME variable in your environment to match the 130 | location of your Java installation." 131 | fi 132 | else 133 | JAVACMD=java 134 | if ! command -v java >/dev/null 2>&1 135 | then 136 | die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 137 | 138 | Please set the JAVA_HOME variable in your environment to match the 139 | location of your Java installation." 140 | fi 141 | fi 142 | 143 | # Increase the maximum file descriptors if we can. 144 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 145 | case $MAX_FD in #( 146 | max*) 147 | # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. 148 | # shellcheck disable=SC2039,SC3045 149 | MAX_FD=$( ulimit -H -n ) || 150 | warn "Could not query maximum file descriptor limit" 151 | esac 152 | case $MAX_FD in #( 153 | '' | soft) :;; #( 154 | *) 155 | # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. 156 | # shellcheck disable=SC2039,SC3045 157 | ulimit -n "$MAX_FD" || 158 | warn "Could not set maximum file descriptor limit to $MAX_FD" 159 | esac 160 | fi 161 | 162 | # Collect all arguments for the java command, stacking in reverse order: 163 | # * args from the command line 164 | # * the main class name 165 | # * -classpath 166 | # * -D...appname settings 167 | # * --module-path (only if needed) 168 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 169 | 170 | # For Cygwin or MSYS, switch paths to Windows format before running java 171 | if "$cygwin" || "$msys" ; then 172 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 173 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 174 | 175 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 176 | 177 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 178 | for arg do 179 | if 180 | case $arg in #( 181 | -*) false ;; # don't mess with options #( 182 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 183 | [ -e "$t" ] ;; #( 184 | *) false ;; 185 | esac 186 | then 187 | arg=$( cygpath --path --ignore --mixed "$arg" ) 188 | fi 189 | # Roll the args list around exactly as many times as the number of 190 | # args, so each arg winds up back in the position where it started, but 191 | # possibly modified. 192 | # 193 | # NB: a `for` loop captures its iteration list before it begins, so 194 | # changing the positional parameters here affects neither the number of 195 | # iterations, nor the values presented in `arg`. 196 | shift # remove old arg 197 | set -- "$@" "$arg" # push replacement arg 198 | done 199 | fi 200 | 201 | 202 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 203 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 204 | 205 | # Collect all arguments for the java command: 206 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, 207 | # and any embedded shellness will be escaped. 208 | # * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be 209 | # treated as '${Hostname}' itself on the command line. 210 | 211 | set -- \ 212 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 213 | -classpath "$CLASSPATH" \ 214 | org.gradle.wrapper.GradleWrapperMain \ 215 | "$@" 216 | 217 | # Stop when "xargs" is not available. 218 | if ! command -v xargs >/dev/null 2>&1 219 | then 220 | die "xargs is not available" 221 | fi 222 | 223 | # Use "xargs" to parse quoted args. 224 | # 225 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 226 | # 227 | # In Bash we could simply go: 228 | # 229 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 230 | # set -- "${ARGS[@]}" "$@" 231 | # 232 | # but POSIX shell has neither arrays nor command substitution, so instead we 233 | # post-process each arg (as a line of input to sed) to backslash-escape any 234 | # character that might be a shell metacharacter, then use eval to reverse 235 | # that process (while maintaining the separation between arguments), and wrap 236 | # the whole thing up as a single "set" statement. 237 | # 238 | # This will of course break if any of these variables contains a newline or 239 | # an unmatched quote. 240 | # 241 | 242 | eval "set -- $( 243 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 244 | xargs -n1 | 245 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 246 | tr '\n' ' ' 247 | )" '"$@"' 248 | 249 | exec "$JAVACMD" "$@" 250 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%"=="" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%"=="" set DIRNAME=. 29 | @rem This is normally unused 30 | set APP_BASE_NAME=%~n0 31 | set APP_HOME=%DIRNAME% 32 | 33 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 34 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 35 | 36 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 37 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 38 | 39 | @rem Find java.exe 40 | if defined JAVA_HOME goto findJavaFromJavaHome 41 | 42 | set JAVA_EXE=java.exe 43 | %JAVA_EXE% -version >NUL 2>&1 44 | if %ERRORLEVEL% equ 0 goto execute 45 | 46 | echo. 1>&2 47 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 48 | echo. 1>&2 49 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2 50 | echo location of your Java installation. 1>&2 51 | 52 | goto fail 53 | 54 | :findJavaFromJavaHome 55 | set JAVA_HOME=%JAVA_HOME:"=% 56 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 57 | 58 | if exist "%JAVA_EXE%" goto execute 59 | 60 | echo. 1>&2 61 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 62 | echo. 1>&2 63 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2 64 | echo location of your Java installation. 1>&2 65 | 66 | goto fail 67 | 68 | :execute 69 | @rem Setup the command line 70 | 71 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 72 | 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if %ERRORLEVEL% equ 0 goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | set EXIT_CODE=%ERRORLEVEL% 85 | if %EXIT_CODE% equ 0 set EXIT_CODE=1 86 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% 87 | exit /b %EXIT_CODE% 88 | 89 | :mainEnd 90 | if "%OS%"=="Windows_NT" endlocal 91 | 92 | :omega 93 | -------------------------------------------------------------------------------- /jitpack.yml: -------------------------------------------------------------------------------- 1 | jdk: 2 | - openjdk11 -------------------------------------------------------------------------------- /lib/.gitignore: -------------------------------------------------------------------------------- 1 | /build -------------------------------------------------------------------------------- /lib/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'com.android.library' 3 | id 'kotlin-android' 4 | id 'maven-publish' 5 | id 'signing' 6 | id("org.jetbrains.kotlin.plugin.compose") version "2.1.10" 7 | } 8 | 9 | apply from: 'maven-publishing.gradle' 10 | 11 | android { 12 | compileSdk = 35 13 | 14 | defaultConfig { 15 | minSdkVersion 21 16 | targetSdkVersion 35 17 | 18 | testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" 19 | consumerProguardFiles "consumer-rules.pro" 20 | } 21 | buildTypes { 22 | release { 23 | minifyEnabled false 24 | proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' 25 | } 26 | } 27 | 28 | compileOptions { 29 | sourceCompatibility JavaVersion.VERSION_21 30 | targetCompatibility JavaVersion.VERSION_21 31 | } 32 | buildFeatures { 33 | compose true 34 | } 35 | namespace 'dev.burnoo.compose.rememberpreference' 36 | publishing { 37 | singleVariant('release') { 38 | withSourcesJar() 39 | withJavadocJar() 40 | } 41 | } 42 | } 43 | 44 | dependencies { 45 | 46 | implementation "androidx.compose.ui:ui:$compose_version" 47 | implementation "androidx.datastore:datastore-preferences:$datastore_version" 48 | 49 | androidTestImplementation("androidx.compose.ui:ui-test-junit4:$compose_version") 50 | androidTestImplementation("androidx.compose.foundation:foundation:$compose_version") 51 | androidTestImplementation("io.kotest:kotest-assertions-core:5.9.1") 52 | debugImplementation("androidx.compose.ui:ui-test-manifest:$compose_version") 53 | } 54 | -------------------------------------------------------------------------------- /lib/consumer-rules.pro: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/burnoo/compose-remember-preference/8e5f0977143233e13f8511555cb97044b3db8cff/lib/consumer-rules.pro -------------------------------------------------------------------------------- /lib/maven-publishing.gradle: -------------------------------------------------------------------------------- 1 | File localProperties = project.rootProject.file('local.properties') 2 | Properties properties = new Properties() 3 | def isLocal = localProperties.exists() 4 | if (isLocal) { 5 | properties.load(new FileInputStream(localProperties)) 6 | } 7 | ext['signing.keyId'] = isLocal ? properties.getProperty('signing.keyId') : 8 | System.getenv('SIGNING_KEY_ID') 9 | ext['signing.password'] = isLocal ? properties.getProperty('signing.password') : 10 | System.getenv('SIGNING_PASSWORD') 11 | ext['signing.secretKeyRingFile'] = isLocal ? properties.getProperty('signing.secretKeyRingFile') : 12 | System.getenv('SIGNING_SECRET_KEY_RING_FILE') 13 | ext['ossrhUsername'] = isLocal ? properties.getProperty('ossrhUsername') : 14 | System.getenv('OSSRH_USERNAME') 15 | ext['ossrhPassword'] = isLocal ? properties.getProperty('ossrhPassword') : 16 | System.getenv('OSSRH_PASSWORD') 17 | ext['sonatypeStagingProfileId'] = isLocal ? properties.getProperty('sonatypeStagingProfileId') : 18 | System.getenv('SONATYPE_STAGING_PROFILE_ID') 19 | 20 | afterEvaluate { 21 | publishing { 22 | publications { 23 | release(MavenPublication) { 24 | from components.release 25 | 26 | groupId = 'dev.burnoo' 27 | artifactId = 'compose-remember-preference' 28 | version = lib_version 29 | 30 | pom { 31 | name = 'compose-remember-preference' 32 | description = 'Persistent MutableState for Jetpack Compose ' + 33 | 'based on DataStore preferences.' 34 | url = 'https://github.com/burnoo/compose-remember-preference' 35 | licenses { 36 | license { 37 | name = 'The Apache License, Version 2.0' 38 | url = 'http://www.apache.org/licenses/LICENSE-2.0.txt' 39 | } 40 | } 41 | developers { 42 | developer { 43 | id = 'burnoo' 44 | name = 'Bruno Wieczorek' 45 | email = 'bruno.wieczorek@gmail.com' 46 | } 47 | } 48 | scm { 49 | connection = 'scm:git:github.com/burnoo/compose-remember-preference.git' 50 | developerConnection = 'scm:git:ssh://github.com/burnoo/compose-remember-preference.git' 51 | url = 'https://github.com/burnoo/compose-remember-preference/tree/master' 52 | } 53 | } 54 | } 55 | } 56 | repositories { 57 | maven { 58 | name = "sonatype" 59 | 60 | def releasesRepoUrl = "https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/" 61 | def snapshotsRepoUrl = "https://s01.oss.sonatype.org/content/repositories/snapshots/" 62 | url = version.endsWith('SNAPSHOT') ? snapshotsRepoUrl : releasesRepoUrl 63 | 64 | credentials { 65 | username ossrhUsername 66 | password ossrhPassword 67 | } 68 | } 69 | } 70 | } 71 | } 72 | 73 | signing { 74 | sign publishing.publications 75 | } 76 | -------------------------------------------------------------------------------- /lib/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # You can control the set of applied configuration files using the 3 | # proguardFiles setting in build.gradle. 4 | # 5 | # For more details, see 6 | # http://developer.android.com/guide/developing/tools/proguard.html 7 | 8 | # If your project uses WebView with JS, uncomment the following 9 | # and specify the fully qualified class name to the JavaScript interface 10 | # class: 11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 12 | # public *; 13 | #} 14 | 15 | # Uncomment this to preserve the line number information for 16 | # debugging stack traces. 17 | #-keepattributes SourceFile,LineNumberTable 18 | 19 | # If you keep the line number information, uncomment this to 20 | # hide the original source file name. 21 | #-renamesourcefileattribute SourceFile -------------------------------------------------------------------------------- /lib/src/androidTest/java/dev/burnoo/compose/rememberpreference/AdvancedRememberPreferenceTest.kt: -------------------------------------------------------------------------------- 1 | package dev.burnoo.compose.rememberpreference 2 | 3 | import android.content.Context 4 | import androidx.compose.foundation.text.BasicText 5 | import androidx.compose.runtime.LaunchedEffect 6 | import androidx.compose.ui.test.assertTextEquals 7 | import androidx.compose.ui.test.isRoot 8 | import androidx.compose.ui.test.junit4.createComposeRule 9 | import androidx.compose.ui.test.onChildAt 10 | import androidx.datastore.preferences.core.edit 11 | import androidx.datastore.preferences.core.stringPreferencesKey 12 | import androidx.test.core.app.ApplicationProvider 13 | import kotlinx.coroutines.runBlocking 14 | import org.junit.After 15 | import org.junit.Rule 16 | import org.junit.Test 17 | 18 | class AdvancedRememberPreferenceTest { 19 | 20 | @get:Rule 21 | val composeTestRule = createComposeRule() 22 | private val context: Context 23 | get() = ApplicationProvider.getApplicationContext() 24 | 25 | @After 26 | fun tearDown() { 27 | runBlocking { context.dataStore.edit { it.clear() } } 28 | } 29 | 30 | @Test 31 | fun shouldUpdateStateWhenDataStoreIsChanged() { 32 | val keyName = "string-key" 33 | val newText = "newText" 34 | composeTestRule.setContent { 35 | val string = rememberStringPreference( 36 | keyName = keyName, 37 | initialValue = "initialText", 38 | defaultValue = "defaultText" 39 | ) 40 | BasicText(string.value) 41 | } 42 | runBlocking { 43 | context.dataStore.edit { 44 | it[stringPreferencesKey(keyName)] = newText 45 | } 46 | } 47 | assertText(newText) 48 | } 49 | 50 | private fun assertText(text: String, index: Int = 0) { 51 | composeTestRule.onNode(isRoot()).onChildAt(index).assertTextEquals(text) 52 | } 53 | } 54 | -------------------------------------------------------------------------------- /lib/src/androidTest/java/dev/burnoo/compose/rememberpreference/RememberBooleanPreferenceTest.kt: -------------------------------------------------------------------------------- 1 | package dev.burnoo.compose.rememberpreference 2 | 3 | import android.content.Context 4 | import androidx.compose.foundation.text.BasicText 5 | import androidx.compose.runtime.LaunchedEffect 6 | import androidx.compose.ui.test.assertTextEquals 7 | import androidx.compose.ui.test.isRoot 8 | import androidx.compose.ui.test.junit4.createComposeRule 9 | import androidx.compose.ui.test.onChildAt 10 | import androidx.datastore.preferences.core.booleanPreferencesKey 11 | import androidx.datastore.preferences.core.edit 12 | import androidx.test.core.app.ApplicationProvider 13 | import io.kotest.matchers.shouldBe 14 | import kotlinx.coroutines.flow.first 15 | import kotlinx.coroutines.runBlocking 16 | import org.junit.After 17 | import org.junit.Rule 18 | import org.junit.Test 19 | 20 | class RememberBooleanPreferenceTest { 21 | 22 | @get:Rule 23 | val composeTestRule = createComposeRule() 24 | private val context: Context 25 | get() = ApplicationProvider.getApplicationContext() 26 | 27 | @After 28 | fun tearDown() { 29 | runBlocking { context.dataStore.edit { it.clear() } } 30 | } 31 | 32 | @Test 33 | fun shouldDisplayDefaultValue() { 34 | val keyName = "boolean-key" 35 | composeTestRule.setContent { 36 | val boolean = rememberBooleanPreference( 37 | keyName = keyName, 38 | defaultValue = false 39 | ) 40 | BasicText(boolean.value.toString()) 41 | } 42 | assertText("false") 43 | } 44 | 45 | @Test 46 | fun shouldRememberBoolean(): Unit = runBlocking { 47 | val keyName = "boolean-key" 48 | composeTestRule.setContent { 49 | val boolean = rememberBooleanPreference( 50 | keyName = keyName, 51 | initialValue = false, 52 | defaultValue = false 53 | ) 54 | LaunchedEffect(Unit) { 55 | boolean.value = true 56 | } 57 | BasicText(boolean.value.toString()) 58 | } 59 | assertText("true") 60 | val preferences = context.dataStore.data.first() 61 | preferences[booleanPreferencesKey(keyName)] shouldBe true 62 | } 63 | 64 | @Test 65 | fun shouldHaveNullDefaultBooleanValue(): Unit = runBlocking { 66 | val keyName = "boolean-key" 67 | composeTestRule.setContent { 68 | val boolean = rememberBooleanPreference( 69 | keyName = keyName, 70 | initialValue = false, 71 | defaultValue = null 72 | ) 73 | BasicText(boolean.value.toString()) 74 | } 75 | assertText("null") 76 | } 77 | 78 | private fun assertText(text: String, index: Int = 0) { 79 | composeTestRule.onNode(isRoot()).onChildAt(index).assertTextEquals(text) 80 | } 81 | } 82 | -------------------------------------------------------------------------------- /lib/src/androidTest/java/dev/burnoo/compose/rememberpreference/RememberDoublePreferenceTest.kt: -------------------------------------------------------------------------------- 1 | package dev.burnoo.compose.rememberpreference 2 | 3 | import android.content.Context 4 | import androidx.compose.foundation.text.BasicText 5 | import androidx.compose.runtime.LaunchedEffect 6 | import androidx.compose.ui.test.assertTextEquals 7 | import androidx.compose.ui.test.isRoot 8 | import androidx.compose.ui.test.junit4.createComposeRule 9 | import androidx.compose.ui.test.onChildAt 10 | import androidx.datastore.preferences.core.edit 11 | import androidx.datastore.preferences.core.doublePreferencesKey 12 | import androidx.test.core.app.ApplicationProvider 13 | import io.kotest.matchers.shouldBe 14 | import kotlinx.coroutines.flow.first 15 | import kotlinx.coroutines.runBlocking 16 | import org.junit.After 17 | import org.junit.Rule 18 | import org.junit.Test 19 | 20 | class RememberDoublePreferenceTest { 21 | 22 | @get:Rule 23 | val composeTestRule = createComposeRule() 24 | private val context: Context 25 | get() = ApplicationProvider.getApplicationContext() 26 | 27 | @After 28 | fun tearDown() { 29 | runBlocking { context.dataStore.edit { it.clear() } } 30 | } 31 | 32 | @Test 33 | fun shouldDisplayDefaultValue() { 34 | val keyName = "double-key" 35 | composeTestRule.setContent { 36 | val double = rememberDoublePreference( 37 | keyName = keyName, 38 | defaultValue = .0 39 | ) 40 | BasicText(double.value.toString()) 41 | } 42 | assertText("0.0") 43 | } 44 | 45 | @Test 46 | fun shouldRememberDouble(): Unit = runBlocking { 47 | val keyName = "double-key" 48 | composeTestRule.setContent { 49 | val double = rememberDoublePreference( 50 | keyName = keyName, 51 | initialValue = .0, 52 | defaultValue = .0 53 | ) 54 | LaunchedEffect(Unit) { 55 | double.value = double.value + 1.0 56 | } 57 | BasicText(double.value.toString()) 58 | } 59 | assertText("1.0") 60 | val preferences = context.dataStore.data.first() 61 | preferences[doublePreferencesKey(keyName)] shouldBe 1f 62 | } 63 | 64 | private fun assertText(text: String, index: Int = 0) { 65 | composeTestRule.onNode(isRoot()).onChildAt(index).assertTextEquals(text) 66 | } 67 | } 68 | -------------------------------------------------------------------------------- /lib/src/androidTest/java/dev/burnoo/compose/rememberpreference/RememberFloatPreferenceTest.kt: -------------------------------------------------------------------------------- 1 | package dev.burnoo.compose.rememberpreference 2 | 3 | import android.content.Context 4 | import androidx.compose.foundation.text.BasicText 5 | import androidx.compose.runtime.LaunchedEffect 6 | import androidx.compose.ui.test.assertTextEquals 7 | import androidx.compose.ui.test.isRoot 8 | import androidx.compose.ui.test.junit4.createComposeRule 9 | import androidx.compose.ui.test.onChildAt 10 | import androidx.datastore.preferences.core.edit 11 | import androidx.datastore.preferences.core.floatPreferencesKey 12 | import androidx.test.core.app.ApplicationProvider 13 | import io.kotest.matchers.shouldBe 14 | import kotlinx.coroutines.flow.first 15 | import kotlinx.coroutines.runBlocking 16 | import org.junit.After 17 | import org.junit.Rule 18 | import org.junit.Test 19 | 20 | class RememberFloatPreferenceTest { 21 | 22 | @get:Rule 23 | val composeTestRule = createComposeRule() 24 | private val context: Context 25 | get() = ApplicationProvider.getApplicationContext() 26 | 27 | @After 28 | fun tearDown() { 29 | runBlocking { context.dataStore.edit { it.clear() } } 30 | } 31 | 32 | @Test 33 | fun shouldDisplayDefaultValue() { 34 | val keyName = "float-key" 35 | composeTestRule.setContent { 36 | val float = rememberFloatPreference( 37 | keyName = keyName, 38 | defaultValue = 0f 39 | ) 40 | BasicText(float.value.toString()) 41 | } 42 | assertText("0.0") 43 | } 44 | 45 | @Test 46 | fun shouldRememberFloat(): Unit = runBlocking { 47 | val keyName = "float-key" 48 | composeTestRule.setContent { 49 | val float = rememberFloatPreference( 50 | keyName = keyName, 51 | initialValue = 0f, 52 | defaultValue = 0f 53 | ) 54 | LaunchedEffect(Unit) { 55 | float.value = float.value + 1f 56 | } 57 | BasicText(float.value.toString()) 58 | } 59 | assertText("1.0") 60 | val preferences = context.dataStore.data.first() 61 | preferences[floatPreferencesKey(keyName)] shouldBe 1f 62 | } 63 | 64 | private fun assertText(text: String, index: Int = 0) { 65 | composeTestRule.onNode(isRoot()).onChildAt(index).assertTextEquals(text) 66 | } 67 | } 68 | -------------------------------------------------------------------------------- /lib/src/androidTest/java/dev/burnoo/compose/rememberpreference/RememberIntPreferenceTest.kt: -------------------------------------------------------------------------------- 1 | package dev.burnoo.compose.rememberpreference 2 | 3 | import android.content.Context 4 | import androidx.compose.foundation.text.BasicText 5 | import androidx.compose.runtime.LaunchedEffect 6 | import androidx.compose.ui.test.assertTextEquals 7 | import androidx.compose.ui.test.isRoot 8 | import androidx.compose.ui.test.junit4.createComposeRule 9 | import androidx.compose.ui.test.onChildAt 10 | import androidx.datastore.preferences.core.edit 11 | import androidx.datastore.preferences.core.intPreferencesKey 12 | import androidx.test.core.app.ApplicationProvider 13 | import io.kotest.matchers.shouldBe 14 | import kotlinx.coroutines.flow.first 15 | import kotlinx.coroutines.runBlocking 16 | import org.junit.After 17 | import org.junit.Rule 18 | import org.junit.Test 19 | 20 | class RememberIntPreferenceTest { 21 | 22 | @get:Rule 23 | val composeTestRule = createComposeRule() 24 | private val context: Context 25 | get() = ApplicationProvider.getApplicationContext() 26 | 27 | @After 28 | fun tearDown() { 29 | runBlocking { context.dataStore.edit { it.clear() } } 30 | } 31 | 32 | @Test 33 | fun shouldDisplayDefaultValue() { 34 | val keyName = "int-key" 35 | composeTestRule.setContent { 36 | val int = rememberIntPreference( 37 | keyName = keyName, 38 | defaultValue = 0 39 | ) 40 | BasicText(int.value.toString()) 41 | } 42 | assertText("0") 43 | } 44 | 45 | @Test 46 | fun shouldRememberInt(): Unit = runBlocking { 47 | val keyName = "int-key" 48 | composeTestRule.setContent { 49 | val int = rememberIntPreference( 50 | keyName = keyName, 51 | initialValue = 0, 52 | defaultValue = 0 53 | ) 54 | LaunchedEffect(Unit) { 55 | int.value = int.value + 1 56 | } 57 | BasicText(int.value.toString()) 58 | } 59 | assertText("1") 60 | val preferences = context.dataStore.data.first() 61 | preferences[intPreferencesKey(keyName)] shouldBe 1 62 | } 63 | 64 | private fun assertText(text: String, index: Int = 0) { 65 | composeTestRule.onNode(isRoot()).onChildAt(index).assertTextEquals(text) 66 | } 67 | } 68 | -------------------------------------------------------------------------------- /lib/src/androidTest/java/dev/burnoo/compose/rememberpreference/RememberLongPreferenceTest.kt: -------------------------------------------------------------------------------- 1 | package dev.burnoo.compose.rememberpreference 2 | 3 | import android.content.Context 4 | import androidx.compose.foundation.text.BasicText 5 | import androidx.compose.runtime.LaunchedEffect 6 | import androidx.compose.ui.test.assertTextEquals 7 | import androidx.compose.ui.test.isRoot 8 | import androidx.compose.ui.test.junit4.createComposeRule 9 | import androidx.compose.ui.test.onChildAt 10 | import androidx.datastore.preferences.core.edit 11 | import androidx.datastore.preferences.core.longPreferencesKey 12 | import androidx.test.core.app.ApplicationProvider 13 | import io.kotest.matchers.shouldBe 14 | import kotlinx.coroutines.flow.first 15 | import kotlinx.coroutines.runBlocking 16 | import org.junit.After 17 | import org.junit.Rule 18 | import org.junit.Test 19 | 20 | class RememberLongPreferenceTest { 21 | 22 | @get:Rule 23 | val composeTestRule = createComposeRule() 24 | private val context: Context 25 | get() = ApplicationProvider.getApplicationContext() 26 | 27 | @After 28 | fun tearDown() { 29 | runBlocking { context.dataStore.edit { it.clear() } } 30 | } 31 | 32 | @Test 33 | fun shouldDisplayDefaultValue() { 34 | val keyName = "long-key" 35 | composeTestRule.setContent { 36 | val long = rememberLongPreference( 37 | keyName = keyName, 38 | defaultValue = 0L 39 | ) 40 | BasicText(long.value.toString()) 41 | } 42 | assertText("0") 43 | } 44 | 45 | @Test 46 | fun shouldRememberLong(): Unit = runBlocking { 47 | val keyName = "long-key" 48 | composeTestRule.setContent { 49 | val long = rememberLongPreference( 50 | keyName = keyName, 51 | initialValue = 0L, 52 | defaultValue = 0L 53 | ) 54 | LaunchedEffect(Unit) { 55 | long.value = long.value + 1L 56 | } 57 | BasicText(long.value.toString()) 58 | } 59 | assertText("1") 60 | val preferences = context.dataStore.data.first() 61 | preferences[longPreferencesKey(keyName)] shouldBe 1L 62 | } 63 | 64 | private fun assertText(text: String, index: Int = 0) { 65 | composeTestRule.onNode(isRoot()).onChildAt(index).assertTextEquals(text) 66 | } 67 | } 68 | -------------------------------------------------------------------------------- /lib/src/androidTest/java/dev/burnoo/compose/rememberpreference/RememberStringPreferenceTest.kt: -------------------------------------------------------------------------------- 1 | package dev.burnoo.compose.rememberpreference 2 | 3 | import android.content.Context 4 | import androidx.compose.foundation.text.BasicText 5 | import androidx.compose.runtime.LaunchedEffect 6 | import androidx.compose.ui.test.assertTextEquals 7 | import androidx.compose.ui.test.isRoot 8 | import androidx.compose.ui.test.junit4.createComposeRule 9 | import androidx.compose.ui.test.onChildAt 10 | import androidx.datastore.preferences.core.edit 11 | import androidx.datastore.preferences.core.stringPreferencesKey 12 | import androidx.test.core.app.ApplicationProvider 13 | import io.kotest.matchers.shouldBe 14 | import kotlinx.coroutines.flow.first 15 | import kotlinx.coroutines.runBlocking 16 | import org.junit.After 17 | import org.junit.Rule 18 | import org.junit.Test 19 | 20 | class RememberStringPreferenceTest { 21 | 22 | @get:Rule 23 | val composeTestRule = createComposeRule() 24 | private val context: Context 25 | get() = ApplicationProvider.getApplicationContext() 26 | 27 | @After 28 | fun tearDown() { 29 | runBlocking { context.dataStore.edit { it.clear() } } 30 | } 31 | 32 | @Test 33 | fun shouldDisplayDefaultValue() { 34 | val keyName = "string-key" 35 | val initialText = "initialText" 36 | composeTestRule.setContent { 37 | val string = rememberStringPreference( 38 | keyName = keyName, 39 | defaultValue = initialText 40 | ) 41 | BasicText(string.value.toString()) 42 | } 43 | assertText(initialText) 44 | } 45 | 46 | @Test 47 | fun shouldRememberString(): Unit = runBlocking { 48 | val keyName = "string-key" 49 | val newText = "newText" 50 | composeTestRule.setContent { 51 | val string = rememberStringPreference( 52 | keyName = keyName, 53 | initialValue = "initialText", 54 | defaultValue = "defaultText" 55 | ) 56 | LaunchedEffect(Unit) { 57 | string.value = newText 58 | } 59 | BasicText(string.value) 60 | } 61 | assertText(newText) 62 | val preferences = context.dataStore.data.first() 63 | preferences[stringPreferencesKey(keyName)] shouldBe newText 64 | } 65 | 66 | private fun assertText(text: String, index: Int = 0) { 67 | composeTestRule.onNode(isRoot()).onChildAt(index).assertTextEquals(text) 68 | } 69 | } 70 | -------------------------------------------------------------------------------- /lib/src/androidTest/java/dev/burnoo/compose/rememberpreference/RememberStringSetPreferenceTest.kt: -------------------------------------------------------------------------------- 1 | package dev.burnoo.compose.rememberpreference 2 | 3 | import android.content.Context 4 | import androidx.compose.foundation.text.BasicText 5 | import androidx.compose.runtime.LaunchedEffect 6 | import androidx.compose.ui.test.assertTextEquals 7 | import androidx.compose.ui.test.isRoot 8 | import androidx.compose.ui.test.junit4.createComposeRule 9 | import androidx.compose.ui.test.onChildAt 10 | import androidx.datastore.preferences.core.edit 11 | import androidx.datastore.preferences.core.stringPreferencesKey 12 | import androidx.test.core.app.ApplicationProvider 13 | import io.kotest.matchers.shouldBe 14 | import kotlinx.coroutines.flow.first 15 | import kotlinx.coroutines.runBlocking 16 | import org.junit.After 17 | import org.junit.Rule 18 | import org.junit.Test 19 | 20 | class RememberStringSetPreferenceTest { 21 | 22 | @get:Rule 23 | val composeTestRule = createComposeRule() 24 | private val context: Context 25 | get() = ApplicationProvider.getApplicationContext() 26 | 27 | @After 28 | fun tearDown() { 29 | runBlocking { context.dataStore.edit { it.clear() } } 30 | } 31 | 32 | @Test 33 | fun shouldDisplayDefaultValue() { 34 | val keyName = "string-set-key" 35 | val initialStringSet = setOf("initialText") 36 | composeTestRule.setContent { 37 | val stringSet = rememberStringSetPreference( 38 | keyName = keyName, 39 | defaultValue = initialStringSet 40 | ) 41 | BasicText(stringSet.value.toString()) 42 | } 43 | assertText(initialStringSet.toString()) 44 | } 45 | 46 | @Test 47 | fun shouldRememberString(): Unit = runBlocking { 48 | val keyName = "string-set-key" 49 | val newStringSet = setOf("newText") 50 | composeTestRule.setContent { 51 | val stringSet = rememberStringSetPreference( 52 | keyName = keyName, 53 | initialValue = setOf("initialText"), 54 | defaultValue = setOf("defaultText") 55 | ) 56 | LaunchedEffect(Unit) { 57 | stringSet.value = newStringSet 58 | } 59 | BasicText(stringSet.value.toString()) 60 | } 61 | assertText(newStringSet.toString()) 62 | val preferences = context.dataStore.data.first() 63 | preferences[stringPreferencesKey(keyName)] shouldBe newStringSet 64 | } 65 | 66 | private fun assertText(text: String, index: Int = 0) { 67 | composeTestRule.onNode(isRoot()).onChildAt(index).assertTextEquals(text) 68 | } 69 | } 70 | -------------------------------------------------------------------------------- /lib/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /lib/src/main/java/dev/burnoo/compose/rememberpreference/RememberPreference.kt: -------------------------------------------------------------------------------- 1 | package dev.burnoo.compose.rememberpreference 2 | 3 | import android.content.Context 4 | import androidx.compose.runtime.* 5 | import androidx.compose.ui.platform.LocalContext 6 | import androidx.datastore.preferences.core.* 7 | import androidx.datastore.preferences.preferencesDataStore 8 | import kotlinx.coroutines.CoroutineScope 9 | import kotlinx.coroutines.Dispatchers 10 | import kotlinx.coroutines.flow.collectLatest 11 | import kotlinx.coroutines.flow.distinctUntilChanged 12 | import kotlinx.coroutines.flow.map 13 | import kotlinx.coroutines.launch 14 | import kotlinx.coroutines.withContext 15 | 16 | internal val Context.dataStore by preferencesDataStore(name = "RememberPreference") 17 | 18 | @Composable 19 | fun rememberIntPreference( 20 | keyName: String, 21 | initialValue: Int? = null, 22 | defaultValue: Int? = null, 23 | ): MutableState = rememberPreference( 24 | keyName, 25 | initialValue, 26 | defaultValue, 27 | ::intPreferencesKey 28 | ) 29 | 30 | @Composable 31 | fun rememberIntPreference( 32 | keyName: String, 33 | initialValue: Int, 34 | defaultValue: Int, 35 | ): MutableState = rememberPreference( 36 | keyName, 37 | initialValue, 38 | defaultValue, 39 | ::intPreferencesKey 40 | ) 41 | 42 | @Composable 43 | fun rememberDoublePreference( 44 | keyName: String, 45 | initialValue: Double? = null, 46 | defaultValue: Double? = null, 47 | ): MutableState = rememberPreference( 48 | keyName, 49 | initialValue, 50 | defaultValue, 51 | ::doublePreferencesKey 52 | ) 53 | 54 | @Composable 55 | fun rememberDoublePreference( 56 | keyName: String, 57 | initialValue: Double, 58 | defaultValue: Double, 59 | ): MutableState = rememberPreference( 60 | keyName, 61 | initialValue, 62 | defaultValue, 63 | ::doublePreferencesKey 64 | ) 65 | 66 | @Composable 67 | fun rememberStringPreference( 68 | keyName: String, 69 | initialValue: String? = null, 70 | defaultValue: String? = null, 71 | ): MutableState = rememberPreference( 72 | keyName, 73 | initialValue, 74 | defaultValue, 75 | ::stringPreferencesKey 76 | ) 77 | 78 | @JvmName("rememberStringPreferenceNotNull") 79 | @Composable 80 | fun rememberStringPreference( 81 | keyName: String, 82 | initialValue: String, 83 | defaultValue: String, 84 | ): MutableState = rememberPreference( 85 | keyName, 86 | initialValue, 87 | defaultValue, 88 | ::stringPreferencesKey 89 | ) 90 | 91 | 92 | @Composable 93 | fun rememberBooleanPreference( 94 | keyName: String, 95 | initialValue: Boolean? = null, 96 | defaultValue: Boolean? = null, 97 | ): MutableState = rememberPreference( 98 | keyName, 99 | initialValue, 100 | defaultValue, 101 | ::booleanPreferencesKey 102 | ) 103 | 104 | @Composable 105 | fun rememberBooleanPreference( 106 | keyName: String, 107 | initialValue: Boolean, 108 | defaultValue: Boolean, 109 | ): MutableState = rememberPreference( 110 | keyName, 111 | initialValue, 112 | defaultValue, 113 | ::booleanPreferencesKey 114 | ) 115 | 116 | @Composable 117 | fun rememberFloatPreference( 118 | keyName: String, 119 | initialValue: Float? = null, 120 | defaultValue: Float? = null, 121 | ): MutableState = rememberPreference( 122 | keyName, 123 | initialValue, 124 | defaultValue, 125 | ::floatPreferencesKey 126 | ) 127 | 128 | @Composable 129 | fun rememberFloatPreference( 130 | keyName: String, 131 | initialValue: Float, 132 | defaultValue: Float, 133 | ): MutableState = rememberPreference( 134 | keyName, 135 | initialValue, 136 | defaultValue, 137 | ::floatPreferencesKey 138 | ) 139 | 140 | @Composable 141 | fun rememberLongPreference( 142 | keyName: String, 143 | initialValue: Long? = null, 144 | defaultValue: Long? = null, 145 | ): MutableState = rememberPreference( 146 | keyName, 147 | initialValue, 148 | defaultValue, 149 | ::longPreferencesKey 150 | ) 151 | 152 | @Composable 153 | fun rememberLongPreference( 154 | keyName: String, 155 | initialValue: Long, 156 | defaultValue: Long, 157 | ): MutableState = rememberPreference( 158 | keyName, 159 | initialValue, 160 | defaultValue, 161 | ::longPreferencesKey 162 | ) 163 | 164 | @Composable 165 | fun rememberStringSetPreference( 166 | keyName: String, 167 | initialValue: Set? = null, 168 | defaultValue: Set? = null, 169 | ): MutableState?> = rememberPreference( 170 | keyName, 171 | initialValue, 172 | defaultValue, 173 | ::stringSetPreferencesKey 174 | ) 175 | 176 | @JvmName("rememberStringSetPreferenceNotNull") 177 | @Composable 178 | fun rememberStringSetPreference( 179 | keyName: String, 180 | initialValue: Set, 181 | defaultValue: Set, 182 | ): MutableState> = rememberPreference( 183 | keyName, 184 | initialValue, 185 | defaultValue, 186 | ::stringSetPreferencesKey 187 | ) 188 | 189 | @Composable 190 | private inline fun rememberPreference( 191 | keyName: String, 192 | initialValue: T, 193 | defaultValue: T, 194 | crossinline getPreferencesKey: (keyName: String) -> Preferences.Key, 195 | ): MutableState { 196 | val coroutineScope = rememberCoroutineScope() 197 | val context = LocalContext.current 198 | return remember { 199 | preferenceMutableState( 200 | coroutineScope = coroutineScope, 201 | context = context, 202 | keyName = keyName, 203 | initialValue = initialValue, 204 | defaultValue = defaultValue, 205 | getPreferencesKey = getPreferencesKey 206 | ) 207 | } 208 | } 209 | 210 | private inline fun preferenceMutableState( 211 | coroutineScope: CoroutineScope, 212 | context: Context, 213 | keyName: String, 214 | initialValue: T, 215 | defaultValue: T, 216 | getPreferencesKey: (keyName: String) -> Preferences.Key, 217 | ): MutableState { 218 | val snapshotMutableState: MutableState = mutableStateOf(initialValue) 219 | val key: Preferences.Key = getPreferencesKey(keyName) 220 | coroutineScope.launch { 221 | context.dataStore.data 222 | .map { if (it[key] == null) defaultValue else it[key] } 223 | .distinctUntilChanged() 224 | .collectLatest { 225 | withContext(Dispatchers.Main) { 226 | snapshotMutableState.value = it as T 227 | } 228 | } 229 | } 230 | return object : MutableState { 231 | override var value: T 232 | get() = snapshotMutableState.value 233 | set(value) { 234 | val rollbackValue = snapshotMutableState.value 235 | snapshotMutableState.value = value 236 | coroutineScope.launch { 237 | try { 238 | context.dataStore.edit { 239 | if (value != null) { 240 | it[key] = value as NNT 241 | } else { 242 | it.remove(key) 243 | } 244 | } 245 | } catch (e: Exception) { 246 | snapshotMutableState.value = rollbackValue 247 | } 248 | } 249 | } 250 | 251 | override fun component1() = value 252 | override fun component2(): (T) -> Unit = { value = it } 253 | } 254 | } 255 | -------------------------------------------------------------------------------- /sample/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'com.android.application' 3 | id 'kotlin-android' 4 | id("org.jetbrains.kotlin.plugin.compose") version "2.1.10" 5 | } 6 | 7 | android { 8 | compileSdk = 35 9 | 10 | defaultConfig { 11 | applicationId "dev.burnoo.compose.rememberpreference.sample" 12 | minSdkVersion 21 13 | targetSdkVersion 35 14 | versionCode 1 15 | versionName "1.0" 16 | 17 | testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" 18 | } 19 | 20 | buildTypes { 21 | release { 22 | minifyEnabled false 23 | proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' 24 | } 25 | } 26 | compileOptions { 27 | sourceCompatibility JavaVersion.VERSION_21 28 | targetCompatibility JavaVersion.VERSION_21 29 | } 30 | buildFeatures { 31 | compose true 32 | } 33 | namespace 'dev.burnoo.compose.rememberpreference.sample' 34 | } 35 | 36 | dependencies { 37 | 38 | implementation project(":lib") 39 | implementation 'androidx.core:core-ktx:1.15.0' 40 | implementation 'androidx.appcompat:appcompat:1.7.0' 41 | implementation 'com.google.android.material:material:1.12.0' 42 | implementation "androidx.compose.ui:ui:$compose_version" 43 | implementation "androidx.compose.material:material:$compose_version" 44 | implementation "androidx.compose.ui:ui-tooling:$compose_version" 45 | implementation 'androidx.lifecycle:lifecycle-runtime-ktx:2.8.7' 46 | implementation 'androidx.activity:activity-compose:1.10.0' 47 | } 48 | -------------------------------------------------------------------------------- /sample/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # You can control the set of applied configuration files using the 3 | # proguardFiles setting in build.gradle. 4 | # 5 | # For more details, see 6 | # http://developer.android.com/guide/developing/tools/proguard.html 7 | 8 | # If your project uses WebView with JS, uncomment the following 9 | # and specify the fully qualified class name to the JavaScript interface 10 | # class: 11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 12 | # public *; 13 | #} 14 | 15 | # Uncomment this to preserve the line number information for 16 | # debugging stack traces. 17 | #-keepattributes SourceFile,LineNumberTable 18 | 19 | # If you keep the line number information, uncomment this to 20 | # hide the original source file name. 21 | #-renamesourcefileattribute SourceFile -------------------------------------------------------------------------------- /sample/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 11 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /sample/src/main/java/dev/burnoo/compose/rememberpreference/sample/AllExample.kt: -------------------------------------------------------------------------------- 1 | package dev.burnoo.compose.rememberpreference.sample 2 | 3 | import androidx.compose.runtime.Composable 4 | import androidx.compose.runtime.getValue 5 | import androidx.compose.runtime.setValue 6 | import dev.burnoo.compose.rememberpreference.rememberBooleanPreference 7 | import dev.burnoo.compose.rememberpreference.rememberIntPreference 8 | import dev.burnoo.compose.rememberpreference.rememberStringPreference 9 | 10 | @Composable 11 | fun Component() { 12 | var string by rememberStringPreference(keyName = "stringKey") 13 | var int by rememberIntPreference(keyName = "intKey", defaultValue = 0) 14 | var boolean by rememberBooleanPreference( 15 | keyName = "booleanKey", initialValue = false, defaultValue = false 16 | ) 17 | } -------------------------------------------------------------------------------- /sample/src/main/java/dev/burnoo/compose/rememberpreference/sample/MainActivity.kt: -------------------------------------------------------------------------------- 1 | package dev.burnoo.compose.rememberpreference.sample 2 | 3 | import android.os.Bundle 4 | import androidx.activity.ComponentActivity 5 | import androidx.activity.compose.setContent 6 | import androidx.compose.animation.AnimatedVisibility 7 | import androidx.compose.animation.ExperimentalAnimationApi 8 | import androidx.compose.foundation.layout.Arrangement 9 | import androidx.compose.foundation.layout.Column 10 | import androidx.compose.foundation.layout.fillMaxSize 11 | import androidx.compose.foundation.layout.fillMaxWidth 12 | import androidx.compose.foundation.layout.padding 13 | import androidx.compose.material.Button 14 | import androidx.compose.material.MaterialTheme 15 | import androidx.compose.material.Surface 16 | import androidx.compose.material.Text 17 | import androidx.compose.material.TextField 18 | import androidx.compose.runtime.Composable 19 | import androidx.compose.runtime.getValue 20 | import androidx.compose.runtime.setValue 21 | import androidx.compose.ui.Alignment 22 | import androidx.compose.ui.Modifier 23 | import androidx.compose.ui.unit.dp 24 | import dev.burnoo.compose.rememberpreference.rememberIntPreference 25 | import dev.burnoo.compose.rememberpreference.rememberStringPreference 26 | import dev.burnoo.compose.rememberpreference.sample.ui.theme.AppTheme 27 | 28 | @ExperimentalAnimationApi 29 | class MainActivity : ComponentActivity() { 30 | override fun onCreate(savedInstanceState: Bundle?) { 31 | super.onCreate(savedInstanceState) 32 | setContent { 33 | AppTheme { 34 | Surface(color = MaterialTheme.colors.background) { 35 | App() 36 | } 37 | } 38 | } 39 | } 40 | } 41 | 42 | @ExperimentalAnimationApi 43 | @Composable 44 | fun App() { 45 | var count by rememberIntPreference( 46 | keyName = "countKey", 47 | initialValue = 0, 48 | defaultValue = 0 49 | ) 50 | val (text, setText) = rememberStringPreference(keyName = "textKey", defaultValue = "Hello!") 51 | 52 | Column( 53 | verticalArrangement = Arrangement.Center, 54 | horizontalAlignment = Alignment.CenterHorizontally, 55 | modifier = Modifier 56 | .fillMaxSize() 57 | .padding(24.dp) 58 | ) { 59 | Clicker(count, onClick = { count++ }) 60 | Input(text, setText) 61 | } 62 | } 63 | 64 | @ExperimentalAnimationApi 65 | @Composable 66 | fun Input(text: String? = "Hello!", setText: (String) -> Unit = {}) { 67 | AnimatedVisibility(visible = text != null) { 68 | TextField( 69 | value = text.orEmpty(), 70 | onValueChange = setText, 71 | modifier = Modifier 72 | .padding(top = 30.dp) 73 | .fillMaxWidth() 74 | ) 75 | } 76 | } 77 | 78 | @Composable 79 | fun Clicker(count: Int = 0, onClick: () -> Unit = {}) { 80 | Button(onClick = onClick) { 81 | Text(text = count.toString()) 82 | } 83 | } -------------------------------------------------------------------------------- /sample/src/main/java/dev/burnoo/compose/rememberpreference/sample/NullabilityExample.kt: -------------------------------------------------------------------------------- 1 | package dev.burnoo.compose.rememberpreference.sample 2 | 3 | import androidx.compose.runtime.Composable 4 | import androidx.compose.runtime.MutableState 5 | import dev.burnoo.compose.rememberpreference.rememberStringPreference 6 | 7 | @Composable 8 | fun NullabilityExample() { 9 | val nullableStringState: MutableState = rememberStringPreference( 10 | keyName = "keyS1", 11 | initialValue = null, // null is default 12 | defaultValue = null // null is default 13 | ) 14 | val stringState: MutableState = rememberStringPreference( 15 | keyName = "keyS2", 16 | initialValue = "Loading", 17 | defaultValue = "Default" 18 | ) 19 | } -------------------------------------------------------------------------------- /sample/src/main/java/dev/burnoo/compose/rememberpreference/sample/OnboardingExample.kt: -------------------------------------------------------------------------------- 1 | package dev.burnoo.compose.rememberpreference.sample 2 | 3 | import androidx.compose.runtime.Composable 4 | import androidx.compose.runtime.getValue 5 | import androidx.compose.runtime.setValue 6 | import dev.burnoo.compose.rememberpreference.rememberBooleanPreference 7 | 8 | @Composable 9 | fun OnboardingExample() { 10 | var isOnboardingCompleted by rememberBooleanPreference( 11 | keyName = "onboardingKey", // preference is stored using this key 12 | initialValue = null, // returned before preference is loaded 13 | defaultValue = false, // returned when preference is not set yet 14 | ) 15 | when (isOnboardingCompleted) { 16 | null -> Loader() 17 | false -> Onboarding(onCompleted = { isOnboardingCompleted = true }) 18 | true -> MainScreen() 19 | } 20 | } 21 | 22 | @Composable 23 | fun Loader() = Unit 24 | 25 | @Composable 26 | fun Onboarding(onCompleted: () -> Unit) = Unit 27 | 28 | @Composable 29 | fun MainScreen() = Unit -------------------------------------------------------------------------------- /sample/src/main/java/dev/burnoo/compose/rememberpreference/sample/ui/theme/Color.kt: -------------------------------------------------------------------------------- 1 | package dev.burnoo.compose.rememberpreference.sample.ui.theme 2 | 3 | import androidx.compose.ui.graphics.Color 4 | 5 | val Purple200 = Color(0xFFBB86FC) 6 | val Purple500 = Color(0xFF6200EE) 7 | val Purple700 = Color(0xFF3700B3) 8 | val Teal200 = Color(0xFF03DAC5) -------------------------------------------------------------------------------- /sample/src/main/java/dev/burnoo/compose/rememberpreference/sample/ui/theme/Shape.kt: -------------------------------------------------------------------------------- 1 | package dev.burnoo.compose.rememberpreference.sample.ui.theme 2 | 3 | import androidx.compose.foundation.shape.RoundedCornerShape 4 | import androidx.compose.material.Shapes 5 | import androidx.compose.ui.unit.dp 6 | 7 | val Shapes = Shapes( 8 | small = RoundedCornerShape(4.dp), 9 | medium = RoundedCornerShape(4.dp), 10 | large = RoundedCornerShape(0.dp) 11 | ) -------------------------------------------------------------------------------- /sample/src/main/java/dev/burnoo/compose/rememberpreference/sample/ui/theme/Theme.kt: -------------------------------------------------------------------------------- 1 | package dev.burnoo.compose.rememberpreference.sample.ui.theme 2 | 3 | import androidx.compose.foundation.isSystemInDarkTheme 4 | import androidx.compose.material.MaterialTheme 5 | import androidx.compose.material.darkColors 6 | import androidx.compose.material.lightColors 7 | import androidx.compose.runtime.Composable 8 | 9 | private val DarkColorPalette = darkColors( 10 | primary = Purple200, 11 | primaryVariant = Purple700, 12 | secondary = Teal200 13 | ) 14 | 15 | private val LightColorPalette = lightColors( 16 | primary = Purple500, 17 | primaryVariant = Purple700, 18 | secondary = Teal200 19 | 20 | /* Other default colors to override 21 | background = Color.White, 22 | surface = Color.White, 23 | onPrimary = Color.White, 24 | onSecondary = Color.Black, 25 | onBackground = Color.Black, 26 | onSurface = Color.Black, 27 | */ 28 | ) 29 | 30 | @Composable 31 | fun AppTheme( 32 | darkTheme: Boolean = isSystemInDarkTheme(), 33 | content: @Composable() () -> Unit 34 | ) { 35 | val colors = if (darkTheme) { 36 | DarkColorPalette 37 | } else { 38 | LightColorPalette 39 | } 40 | 41 | MaterialTheme( 42 | colors = colors, 43 | typography = Typography, 44 | shapes = Shapes, 45 | content = content 46 | ) 47 | } -------------------------------------------------------------------------------- /sample/src/main/java/dev/burnoo/compose/rememberpreference/sample/ui/theme/Type.kt: -------------------------------------------------------------------------------- 1 | package dev.burnoo.compose.rememberpreference.sample.ui.theme 2 | 3 | import androidx.compose.material.Typography 4 | import androidx.compose.ui.text.TextStyle 5 | import androidx.compose.ui.text.font.FontFamily 6 | import androidx.compose.ui.text.font.FontWeight 7 | import androidx.compose.ui.unit.sp 8 | 9 | // Set of Material typography styles to start with 10 | val Typography = Typography( 11 | body1 = TextStyle( 12 | fontFamily = FontFamily.Default, 13 | fontWeight = FontWeight.Normal, 14 | fontSize = 16.sp 15 | ) 16 | /* Other default text styles to override 17 | button = TextStyle( 18 | fontFamily = FontFamily.Default, 19 | fontWeight = FontWeight.W500, 20 | fontSize = 14.sp 21 | ), 22 | caption = TextStyle( 23 | fontFamily = FontFamily.Default, 24 | fontWeight = FontWeight.Normal, 25 | fontSize = 12.sp 26 | ) 27 | */ 28 | ) -------------------------------------------------------------------------------- /sample/src/main/res/drawable-v24/ic_launcher_foreground.xml: -------------------------------------------------------------------------------- 1 | 7 | 8 | 9 | 15 | 18 | 21 | 22 | 23 | 24 | 30 | -------------------------------------------------------------------------------- /sample/src/main/res/drawable/ic_launcher_background.xml: -------------------------------------------------------------------------------- 1 | 2 | 7 | 10 | 15 | 20 | 25 | 30 | 35 | 40 | 45 | 50 | 55 | 60 | 65 | 70 | 75 | 80 | 85 | 90 | 95 | 100 | 105 | 110 | 115 | 120 | 125 | 130 | 135 | 140 | 145 | 150 | 155 | 160 | 165 | 170 | 171 | -------------------------------------------------------------------------------- /sample/src/main/res/mipmap-anydpi-v26/ic_launcher.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | -------------------------------------------------------------------------------- /sample/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | -------------------------------------------------------------------------------- /sample/src/main/res/mipmap-hdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/burnoo/compose-remember-preference/8e5f0977143233e13f8511555cb97044b3db8cff/sample/src/main/res/mipmap-hdpi/ic_launcher.webp -------------------------------------------------------------------------------- /sample/src/main/res/mipmap-hdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/burnoo/compose-remember-preference/8e5f0977143233e13f8511555cb97044b3db8cff/sample/src/main/res/mipmap-hdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /sample/src/main/res/mipmap-mdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/burnoo/compose-remember-preference/8e5f0977143233e13f8511555cb97044b3db8cff/sample/src/main/res/mipmap-mdpi/ic_launcher.webp -------------------------------------------------------------------------------- /sample/src/main/res/mipmap-mdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/burnoo/compose-remember-preference/8e5f0977143233e13f8511555cb97044b3db8cff/sample/src/main/res/mipmap-mdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /sample/src/main/res/mipmap-xhdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/burnoo/compose-remember-preference/8e5f0977143233e13f8511555cb97044b3db8cff/sample/src/main/res/mipmap-xhdpi/ic_launcher.webp -------------------------------------------------------------------------------- /sample/src/main/res/mipmap-xhdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/burnoo/compose-remember-preference/8e5f0977143233e13f8511555cb97044b3db8cff/sample/src/main/res/mipmap-xhdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /sample/src/main/res/mipmap-xxhdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/burnoo/compose-remember-preference/8e5f0977143233e13f8511555cb97044b3db8cff/sample/src/main/res/mipmap-xxhdpi/ic_launcher.webp -------------------------------------------------------------------------------- /sample/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/burnoo/compose-remember-preference/8e5f0977143233e13f8511555cb97044b3db8cff/sample/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /sample/src/main/res/mipmap-xxxhdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/burnoo/compose-remember-preference/8e5f0977143233e13f8511555cb97044b3db8cff/sample/src/main/res/mipmap-xxxhdpi/ic_launcher.webp -------------------------------------------------------------------------------- /sample/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/burnoo/compose-remember-preference/8e5f0977143233e13f8511555cb97044b3db8cff/sample/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /sample/src/main/res/values-night/themes.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 16 | -------------------------------------------------------------------------------- /sample/src/main/res/values/colors.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | #FFBB86FC 4 | #FF6200EE 5 | #FF3700B3 6 | #FF03DAC5 7 | #FF018786 8 | #FF000000 9 | #FFFFFFFF 10 | -------------------------------------------------------------------------------- /sample/src/main/res/values/strings.xml: -------------------------------------------------------------------------------- 1 | 2 | Remember Preference Sample 3 | -------------------------------------------------------------------------------- /sample/src/main/res/values/themes.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 16 | 17 | 21 | 22 |