feat: Add ability to open library screen at startup (#269)

Also cleanup and refine settings screen & view-model logic
---------

Signed-off-by: starry-shivam <starry@krsh.dev>

Author: starry-shivam

app/src/main/java/com/starry/myne/MainViewModel.kt

@@ -29,6 +29,7 @@ import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
 import com.starry.myne.database.library.LibraryDao
 import com.starry.myne.database.progress.ProgressDao
+import com.starry.myne.helpers.PreferenceUtil
 import com.starry.myne.ui.navigation.BottomBarScreen
 import com.starry.myne.ui.navigation.Screens
 import com.starry.myne.ui.screens.welcome.viewmodels.WelcomeDataStore
@@ -43,7 +44,8 @@ import javax.inject.Inject
 class MainViewModel @Inject constructor(
     private val welcomeDataStore: WelcomeDataStore,
     private val libraryDao: LibraryDao,
-    private val progressDao: ProgressDao
+    private val progressDao: ProgressDao,
+    private val preferenceUtil: PreferenceUtil
 ) :
     ViewModel() {
     private val _isLoading: MutableState<Boolean> = mutableStateOf(true)
@@ -69,7 +71,13 @@ class MainViewModel @Inject constructor(
             // Check if user has completed onboarding.
             welcomeDataStore.readOnBoardingState().collect { completed ->
                 if (completed) {
-                    _startDestination.value = BottomBarScreen.Home.route
+                    val openLibrary =
+                        preferenceUtil.getBoolean(PreferenceUtil.OPEN_LIBRARY_AT_START_BOOL, false)
+                    if (openLibrary) {
+                        _startDestination.value = BottomBarScreen.Library.route
+                    } else {
+                        _startDestination.value = BottomBarScreen.Home.route
+                    }
                 } else {
                     _startDestination.value = Screens.WelcomeScreen.route
                 }

app/src/main/java/com/starry/myne/helpers/Preferencesutils.kt

@@ -30,14 +30,21 @@ class PreferenceUtil(context: Context) {
     companion object {
         private const val PREFS_NAME = "myne_settings"
 
-        // Preference keys
+        // General settings preference keys
+        const val INTERNAL_READER_BOOL = "internal_reader"
+        const val USE_GOOGLE_API_BOOL = "use_google_books_api"
+        const val OPEN_LIBRARY_AT_START_BOOL = "launch_library_at_start"
+
+        // App theme preference keys
         const val APP_THEME_INT = "theme_settings"
         const val AMOLED_THEME_BOOL = "amoled_theme"
         const val MATERIAL_YOU_BOOL = "material_you"
-        const val INTERNAL_READER_BOOL = "internal_reader"
-        const val USE_GOOGLE_API_BOOL = "use_google_books_api"
+
+        // Reader preference keys
         const val READER_FONT_SIZE_INT = "reader_font_size"
         const val READER_FONT_STYLE_STR = "reader_font_style"
+
+        // Home screen preference keys
         const val PREFERRED_BOOK_LANG_STR = "preferred_book_language"
 
         // Temporary preference keys
@@ -54,6 +61,10 @@ class PreferenceUtil(context: Context) {
         prefs.edit {
             if (!keyExists(INTERNAL_READER_BOOL)) putBoolean(INTERNAL_READER_BOOL, true)
             if (!keyExists(USE_GOOGLE_API_BOOL)) putBoolean(USE_GOOGLE_API_BOOL, true)
+            if (!keyExists(OPEN_LIBRARY_AT_START_BOOL)) putBoolean(
+                OPEN_LIBRARY_AT_START_BOOL,
+                false
+            )
         }
     }
 

app/src/main/java/com/starry/myne/ui/screens/settings/composables/SettingsItems.kt

@@ -44,7 +44,7 @@ import androidx.compose.material3.SwitchDefaults
 import androidx.compose.material3.Text
 import androidx.compose.material3.surfaceColorAtElevation
 import androidx.compose.runtime.Composable
-import androidx.compose.runtime.MutableState
+import androidx.compose.runtime.State
 import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.remember
 import androidx.compose.ui.Alignment
@@ -141,7 +141,7 @@ fun SettingItemWIthSwitch(
     icon: ImageVector,
     mainText: String,
     subText: String,
-    switchState: MutableState<Boolean>,
+    switchState: State<Boolean>,
     onCheckChange: (Boolean) -> Unit
 ) {
     val view = LocalView.current

app/src/main/java/com/starry/myne/ui/screens/settings/composables/SettingsScreen.kt

@@ -60,6 +60,7 @@ import androidx.compose.material3.SnackbarHostState
 import androidx.compose.material3.Text
 import androidx.compose.material3.TextButton
 import androidx.compose.runtime.Composable
+import androidx.compose.runtime.livedata.observeAsState
 import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.remember
 import androidx.compose.runtime.rememberCoroutineScope
@@ -207,8 +208,11 @@ private fun GeneralOptionsUI(
     val context = LocalContext.current
     val coroutineScope = rememberCoroutineScope()
 
-    val googleBooksApiSwitchState = remember { mutableStateOf(viewModel.getUseGoogleApiValue()) }
-    val internalReaderValue = when (viewModel.getInternalReaderValue()) {
+    val googleBooksApiSwitchState = viewModel.useGoogleApi.observeAsState(initial = true)
+    val internalReaderState = viewModel.internalReader.observeAsState(initial = true)
+    val openLibraryAtStartState = viewModel.openLibraryAtStart.observeAsState(initial = false)
+
+    val internalReaderValue = when (internalReaderState.value) {
         true -> stringResource(id = R.string.reader_option_inbuilt)
         false -> stringResource(id = R.string.reader_option_external)
     }
@@ -268,7 +272,16 @@ private fun GeneralOptionsUI(
             switchState = googleBooksApiSwitchState,
             onCheckChange = {
                 viewModel.setUseGoogleApiValue(it)
-                googleBooksApiSwitchState.value = it
+            }
+        )
+
+        SettingItemWIthSwitch(
+            icon = ImageVector.vectorResource(id = R.drawable.ic_settings_library_start),
+            mainText = stringResource(id = R.string.open_library_at_start_setting),
+            subText = stringResource(id = R.string.open_library_at_start_setting_desc),
+            switchState = openLibraryAtStartState,
+            onCheckChange = {
+                viewModel.setOpenLibraryAtStartValue(it)
             }
         )
     }
@@ -358,31 +371,33 @@ private fun DisplayOptionsUI(
     val coroutineScope = rememberCoroutineScope()
 
     // Display settings for the theme
-    val displayValue =
-        when (viewModel.getThemeValue()) {
-            ThemeMode.Light.ordinal -> stringResource(id = R.string.theme_option_light)
-            ThemeMode.Dark.ordinal -> stringResource(id = R.string.theme_option_dark)
-            else -> stringResource(id = R.string.theme_option_system)
-        }
-    val displayDialog = remember { mutableStateOf(false) }
-    val radioOptions = listOf(
+    val appThemeState = viewModel.theme.observeAsState(initial = ThemeMode.Auto)
+    val selectedAppTheme = when (appThemeState.value) {
+        ThemeMode.Light -> stringResource(id = R.string.theme_option_light)
+        ThemeMode.Dark -> stringResource(id = R.string.theme_option_dark)
+        else -> stringResource(id = R.string.theme_option_system)
+    }
+    val appThemeDialog = remember { mutableStateOf(false) }
+    val appThemeRadioOpts = listOf(
         stringResource(id = R.string.theme_option_light),
         stringResource(id = R.string.theme_option_dark),
         stringResource(id = R.string.theme_option_system)
     )
-    val (selectedOption, onOptionSelected) = remember { mutableStateOf(displayValue) }
+    val (selectedOption, onOptionSelected) = remember { mutableStateOf(selectedAppTheme) }
 
     // Display settings for the amoled theme
-    val amoledSwitch = remember { mutableStateOf(viewModel.getAmoledThemeValue()) }
-    val amoledDesc = if (amoledSwitch.value) {
+    val amoledState = viewModel.amoledTheme.observeAsState(initial = false)
+    val amoledDesc = if (amoledState.value) {
         stringResource(id = R.string.amoled_theme_setting_enabled_desc)
     } else {
         stringResource(id = R.string.amoled_theme_setting_disabled_desc)
     }
 
     // Display settings for the Material You theme
-    val materialYouSwitch = remember { mutableStateOf(viewModel.getMaterialYouValue()) }
-    val materialYouDesc = if (materialYouSwitch.value) {
+    val materialYouState = viewModel.materialYou.observeAsState(
+        initial = Build.VERSION.SDK_INT >= Build.VERSION_CODES.S
+    )
+    val materialYouDesc = if (materialYouState.value) {
         stringResource(id = R.string.material_you_setting_enabled_desc)
     } else {
         stringResource(id = R.string.material_you_setting_disabled_desc)
@@ -404,39 +419,36 @@ private fun DisplayOptionsUI(
         SettingItem(
             icon = Icons.Filled.BrightnessMedium,
             mainText = stringResource(id = R.string.theme_setting),
-            subText = displayValue,
-            onClick = { displayDialog.value = true }
+            subText = selectedAppTheme,
+            onClick = { appThemeDialog.value = true }
         )
         SettingItemWIthSwitch(
             icon = Icons.Filled.Contrast,
             mainText = stringResource(id = R.string.amoled_theme_setting),
             subText = amoledDesc,
-            switchState = amoledSwitch,
+            switchState = amoledState,
             onCheckChange = {
                 viewModel.setAmoledTheme(it)
-                amoledSwitch.value = it
             })
         SettingItemWIthSwitch(
             icon = Icons.Filled.Palette,
             mainText = stringResource(id = R.string.material_you_setting),
             subText = materialYouDesc,
-            switchState = materialYouSwitch,
+            switchState = materialYouState,
             onCheckChange = { materialYouValue ->
                 if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S) {
                     viewModel.setMaterialYou(materialYouValue)
-                    materialYouSwitch.value = materialYouValue
                 } else {
                     viewModel.setMaterialYou(false)
-                    materialYouSwitch.value = false
                     coroutineScope.launch { snackBarHostState.showSnackbar(context.getString(R.string.material_you_error)) }
                 }
             }
         )
     }
 
-    if (displayDialog.value) {
+    if (appThemeDialog.value) {
         AlertDialog(onDismissRequest = {
-            displayDialog.value = false
+            appThemeDialog.value = false
         }, title = {
             Text(
                 text = stringResource(id = R.string.theme_dialog_title),
@@ -447,7 +459,7 @@ private fun DisplayOptionsUI(
                 modifier = Modifier.selectableGroup(),
                 verticalArrangement = Arrangement.Center,
             ) {
-                radioOptions.forEach { text ->
+                appThemeRadioOpts.forEach { text ->
                     Row(
                         modifier = Modifier
                             .fillMaxWidth()
@@ -481,7 +493,7 @@ private fun DisplayOptionsUI(
         }, confirmButton = {
             FilledTonalButton(
                 onClick = {
-                    displayDialog.value = false
+                    appThemeDialog.value = false
 
                     when (selectedOption) {
                         context.getString(R.string.theme_option_light) -> {
@@ -505,7 +517,7 @@ private fun DisplayOptionsUI(
             }
         }, dismissButton = {
             TextButton(onClick = {
-                displayDialog.value = false
+                appThemeDialog.value = false
             }) {
                 Text(stringResource(id = R.string.cancel))
             }

app/src/main/java/com/starry/myne/ui/screens/settings/viewmodels/SettingsViewModel.kt

@@ -38,18 +38,28 @@ class SettingsViewModel @Inject constructor(
     private val _theme = MutableLiveData(ThemeMode.Auto)
     private val _amoledTheme = MutableLiveData(false)
     private val _materialYou = MutableLiveData(Build.VERSION.SDK_INT >= Build.VERSION_CODES.S)
+    private val _internalReader = MutableLiveData(true)
+    private val _useGoogleApi = MutableLiveData(true)
+    private val _openLibraryAtStart = MutableLiveData(false)
 
     val theme: LiveData<ThemeMode> = _theme
     val amoledTheme: LiveData<Boolean> = _amoledTheme
     val materialYou: LiveData<Boolean> = _materialYou
+    val internalReader: LiveData<Boolean> = _internalReader
+    val useGoogleApi: LiveData<Boolean> = _useGoogleApi
+    val openLibraryAtStart: LiveData<Boolean> = _openLibraryAtStart
 
     init {
         _theme.value = ThemeMode.entries.toTypedArray()[getThemeValue()]
         _amoledTheme.value = getAmoledThemeValue()
         _materialYou.value = getMaterialYouValue()
+        _internalReader.value = getInternalReaderValue()
+        _useGoogleApi.value = getUseGoogleApiValue()
+        _openLibraryAtStart.value = getOpenLibraryAtStartValue()
     }
 
-    // Getters ================================================================================
+    // Getters =============================================================================
+
     fun setTheme(newTheme: ThemeMode) {
         _theme.postValue(newTheme)
         preferenceUtil.putInt(PreferenceUtil.APP_THEME_INT, newTheme.ordinal)
@@ -66,35 +76,46 @@ class SettingsViewModel @Inject constructor(
     }
 
     fun setInternalReaderValue(newValue: Boolean) {
+        _internalReader.postValue(newValue)
         preferenceUtil.putBoolean(PreferenceUtil.INTERNAL_READER_BOOL, newValue)
     }
 
     fun setUseGoogleApiValue(newValue: Boolean) {
+        _useGoogleApi.postValue(newValue)
         preferenceUtil.putBoolean(PreferenceUtil.USE_GOOGLE_API_BOOL, newValue)
     }
 
-    // Getters ================================================================================
+    fun setOpenLibraryAtStartValue(newValue: Boolean) {
+        _openLibraryAtStart.postValue(newValue)
+        preferenceUtil.putBoolean(PreferenceUtil.OPEN_LIBRARY_AT_START_BOOL, newValue)
+    }
 
-    fun getThemeValue() = preferenceUtil.getInt(
+    // Getters ============================================================================
+    // Used only during initialization except getCurrentTheme()
+    private fun getThemeValue() = preferenceUtil.getInt(
         PreferenceUtil.APP_THEME_INT, ThemeMode.Auto.ordinal
     )
 
-    fun getAmoledThemeValue() = preferenceUtil.getBoolean(
+    private fun getAmoledThemeValue() = preferenceUtil.getBoolean(
         PreferenceUtil.AMOLED_THEME_BOOL, false
     )
 
-    fun getMaterialYouValue() = preferenceUtil.getBoolean(
+    private fun getMaterialYouValue() = preferenceUtil.getBoolean(
         PreferenceUtil.MATERIAL_YOU_BOOL, Build.VERSION.SDK_INT >= Build.VERSION_CODES.S
     )
 
-    fun getInternalReaderValue() = preferenceUtil.getBoolean(
+    private fun getInternalReaderValue() = preferenceUtil.getBoolean(
         PreferenceUtil.INTERNAL_READER_BOOL, true
     )
 
-    fun getUseGoogleApiValue() = preferenceUtil.getBoolean(
+    private fun getUseGoogleApiValue() = preferenceUtil.getBoolean(
         PreferenceUtil.USE_GOOGLE_API_BOOL, true
     )
 
+    private fun getOpenLibraryAtStartValue() = preferenceUtil.getBoolean(
+        PreferenceUtil.OPEN_LIBRARY_AT_START_BOOL, false
+    )
+
     @Composable
     fun getCurrentTheme(): ThemeMode {
         return if (theme.value == ThemeMode.Auto) {

app/src/main/res/drawable/ic_settings_google_api.xml

@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
 <vector xmlns:android="http://schemas.android.com/apk/res/android"
     android:width="24dp"
     android:height="24dp"
@@ -6,6 +7,6 @@
 
     <path
         android:fillColor="#000000"
-        android:pathData="M19.76,10.77L19.67,10.42H12.23V13.58H16.68C16.432,14.544 15.867,15.397 15.077,16.003C14.286,16.608 13.316,16.931 12.32,16.92C11.021,16.909 9.773,16.413 8.82,15.53C8.352,15.068 7.979,14.519 7.723,13.913C7.468,13.308 7.334,12.658 7.33,12C7.345,10.679 7.868,9.415 8.79,8.47C9.729,7.58 10.976,7.089 12.27,7.1C13.378,7.109 14.445,7.521 15.27,8.26L17.47,6C16.02,4.706 14.143,3.994 12.2,4C11.131,3.994 10.071,4.198 9.081,4.601C8.091,5.004 7.19,5.599 6.43,6.35C4.984,7.852 4.168,9.852 4.152,11.937C4.135,14.022 4.918,16.035 6.34,17.56C7.128,18.345 8.064,18.965 9.094,19.384C10.125,19.803 11.228,20.012 12.34,20C13.348,20.007 14.348,19.81 15.278,19.42C16.208,19.03 17.049,18.455 17.75,17.73C19.126,16.217 19.87,14.235 19.83,12.19C19.841,11.716 19.817,11.241 19.76,10.77Z" />
-
-</vector>
+        android:pathData="M12.5,10.2v3.8H18c-0.7,2.3-2.6,4-5.4,4c-3.3,0-6-2.7-6-6s2.7-6,6-6c1.5,0,2.9,0.5,3.9,1.5l2.8-2.8C17.5,3,15.1,2,12.5,2 C7,2,2.5,6.5,2.5,12s4.5,10,10,10c8.4,0,10.2-7.9,9.4-11.7L12.5,10.2z" />
+    <path android:pathData="M 0 0 H 24 V 24 H 0 V 0 Z" />
+</vector>

app/src/main/res/drawable/ic_settings_library_start.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="utf-8"?>
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:viewportWidth="24"
+    android:viewportHeight="24">
+
+    <path android:pathData="M0 0h24v24H0z" />
+    <path
+        android:fillColor="#000000"
+        android:pathData="M20 22H6.5A3.5 3.5 0 0 1 3 18.5V5a3 3 0 0 1 3-3h14a1 1 0 0 1 1 1v18a1 1 0 0 1-1 1zm-1-2v-3H6.5a1.5 1.5 0 0 0 0 3H19zM10 4v8l3.5-2 3.5 2V4h-7z" />
+</vector>

app/src/main/res/drawable/ic_settings_reader.xml

@@ -5,8 +5,10 @@
     android:viewportWidth="24"
     android:viewportHeight="24">
 
-    <path android:pathData="M0 0h24v24H0z" />
     <path
-        android:fillColor="#000000"
-        android:pathData="M20 22H6.5A3.5 3.5 0 0 1 3 18.5V5a3 3 0 0 1 3-3h14a1 1 0 0 1 1 1v18a1 1 0 0 1-1 1zm-1-2v-3H6.5a1.5 1.5 0 0 0 0 3H19zM10 4v8l3.5-2 3.5 2V4h-7z" />
+        android:fillColor="#292D32"
+        android:pathData="M22 4.84969V16.7397C22 17.7097 21.21 18.5997 20.24 18.7197L19.93 18.7597C18.29 18.9797 15.98 19.6597 14.12 20.4397C13.47 20.7097 12.75 20.2197 12.75 19.5097V5.59969C12.75 5.22969 12.96 4.88969 13.29 4.70969C15.12 3.71969 17.89 2.83969 19.77 2.67969H19.83C21.03 2.67969 22 3.64969 22 4.84969Z" />
+    <path
+        android:fillColor="#292D32"
+        android:pathData="M10.7083 4.70969C8.87828 3.71969 6.10828 2.83969 4.22828 2.67969H4.15828C2.95828 2.67969 1.98828 3.64969 1.98828 4.84969V16.7397C1.98828 17.7097 2.77828 18.5997 3.74828 18.7197L4.05828 18.7597C5.69828 18.9797 8.00828 19.6597 9.86828 20.4397C10.5183 20.7097 11.2383 20.2197 11.2383 19.5097V5.59969C11.2383 5.21969 11.0383 4.88969 10.7083 4.70969ZM4.99828 7.73969H7.24828C7.65828 7.73969 7.99828 8.07969 7.99828 8.48969C7.99828 8.90969 7.65828 9.23969 7.24828 9.23969H4.99828C4.58828 9.23969 4.24828 8.90969 4.24828 8.48969C4.24828 8.07969 4.58828 7.73969 4.99828 7.73969ZM7.99828 12.2397H4.99828C4.58828 12.2397 4.24828 11.9097 4.24828 11.4897C4.24828 11.0797 4.58828 10.7397 4.99828 10.7397H7.99828C8.40828 10.7397 8.74828 11.0797 8.74828 11.4897C8.74828 11.9097 8.40828 12.2397 7.99828 12.2397Z" />
 </vector>

app/src/main/res/values-ar/strings.xml

@@ -107,6 +107,8 @@
     <string name="locale_setting_not_found">عذرا! هذه الميزة ليست مدعومة حاليا من قبل نظام التشغيل الخاص بك.</string>
     <string name="google_books_api_setting">واجهة برمجة تطبيقات كتب Google</string>
     <string name="google_books_api_setting_desc">استخدم واجهة برمجة تطبيقات كتب Google لجلب معلومات إضافية عن الكتب.</string>
+    <string name="open_library_at_start_setting">افتح المكتبة عند البدء</string>
+    <string name="open_library_at_start_setting_desc">افتح شاشة المكتبة عند بدء التطبيق.</string>
     <string name="display_setting_header">العرض</string>
     <string name="theme_setting">المظهر الافتراضى</string>
     <string name="theme_dialog_title">تغيير المظهر</string>

app/src/main/res/values-bn/strings.xml

@@ -107,6 +107,8 @@
     <string name="locale_setting_not_found">দুঃখিত! এই ফিচার এখনও আপনার ওএস এর জন্য আসেনি৷</string>
     <string name="google_books_api_setting">গুগল বই API</string>
     <string name="google_books_api_setting_desc">অতিরিক্ত বইয়ের তথ্য আনতে Google Books API ব্যবহার করুন।</string>
+    <string name="open_library_at_start_setting">স্টার্টে লাইব্রেরি খুলুন</string>
+    <string name="open_library_at_start_setting_desc">অ্যাপ শুরু হলে লাইব্রেরি স্ক্রিন খুলুন।</string>
     <string name="display_setting_header">ডিসপ্লে</string>
     <string name="theme_setting">ডিফল্ট থিম</string>
     <string name="theme_dialog_title">থিম বদলান</string>