Add toolip about swipe actions in library (#98)

* Also reorganise Italian strings --------- Signed-off-by: starry-shivam <[email protected]>
Pool-Of-Tears · Dec 16, 2023 · c4d9a47 · c4d9a47
1 parent ece3bb7
commit c4d9a47
Show file tree

Hide file tree

Showing 16 changed files with 203 additions and 81 deletions.
diff --git a/.idea/appInsightsSettings.xml b/.idea/appInsightsSettings.xml
diff --git a/app/build.gradle b/app/build.gradle
@@ -126,7 +126,7 @@ dependencies {
     implementation "com.mikepenz:aboutlibraries-core:10.5.2"
     implementation "com.mikepenz:aboutlibraries-compose:10.5.2"
     // Swipe actions.
-    implementation "me.saket.swipe:swipe:1.0.0"
+    implementation "me.saket.swipe:swipe:1.2.0"
     // Crash Handler.
     implementation 'cat.ereza:customactivityoncrash:2.4.0'
     // Kotlin reflect API.

diff --git a/app/src/main/java/com/starry/myne/ui/screens/home/viewmodels/HomeViewModel.kt b/app/src/main/java/com/starry/myne/ui/screens/home/viewmodels/HomeViewModel.kt
@@ -96,7 +96,7 @@ class HomeViewModel @Inject constructor(
          * this: {"detail": "Invalid page."}. Hence the [BookSet] attributes become
          * null in this case and can cause crashes.
          */
-        val books = if (bookSet.books != null) {
+        @Suppress("SENSELESS_COMPARISON") val books = if (bookSet.books != null) {
             bookSet.books.filter { it.formats.applicationepubzip != null } as ArrayList<Book>
         } else {
             ArrayList()

diff --git a/app/src/main/java/com/starry/myne/ui/screens/library/composables/LibraryScreen.kt b/app/src/main/java/com/starry/myne/ui/screens/library/composables/LibraryScreen.kt
@@ -44,10 +44,15 @@ import androidx.compose.material3.ExperimentalMaterial3Api
 import androidx.compose.material3.Icon
 import androidx.compose.material3.MaterialTheme
 import androidx.compose.material3.Scaffold
+import androidx.compose.material3.SnackbarDuration
+import androidx.compose.material3.SnackbarHost
+import androidx.compose.material3.SnackbarHostState
+import androidx.compose.material3.SnackbarResult
 import androidx.compose.material3.Text
 import androidx.compose.material3.TextButton
 import androidx.compose.material3.surfaceColorAtElevation
 import androidx.compose.runtime.Composable
+import androidx.compose.runtime.LaunchedEffect
 import androidx.compose.runtime.getValue
 import androidx.compose.runtime.livedata.observeAsState
 import androidx.compose.runtime.mutableStateOf
@@ -104,13 +109,18 @@ import java.io.File
 fun LibraryScreen(navController: NavController) {
     val viewModel: LibraryViewModel = hiltViewModel()
     val state = viewModel.allItems.observeAsState(listOf()).value
+
     val context = LocalContext.current
     val settingsViewModel = (context.getActivity() as MainActivity).settingsViewModel
 
+    val snackBarHostState = remember { SnackbarHostState() }
+
     Scaffold(
+        snackbarHost = { SnackbarHost(snackBarHostState) },
         modifier = Modifier
             .fillMaxSize()
-            .background(MaterialTheme.colorScheme.background),
+            .background(MaterialTheme.colorScheme.background)
+            .padding(bottom = 70.dp),
         topBar = {
             CustomTopAppBar(
                 headerText = stringResource(id = R.string.library_header),
@@ -123,7 +133,6 @@ fun LibraryScreen(navController: NavController) {
                 modifier = Modifier
                     .fillMaxSize()
                     .background(MaterialTheme.colorScheme.background)
-                    .padding(bottom = 70.dp)
             ) {
                 if (state.isEmpty()) {
                     NoLibraryItemAnimation()
@@ -211,7 +220,7 @@ fun LibraryScreen(navController: NavController) {
                                                 context.getString(R.string.error).toToast(context)
                                             }
                                         }) {
-                                            Text(stringResource(id = R.string.dialog_confirm_button))
+                                            Text(stringResource(id = R.string.confirm))
                                         }
                                     }, dismissButton = {
                                         TextButton(onClick = {
@@ -227,6 +236,24 @@ fun LibraryScreen(navController: NavController) {
                             }
                         }
                     }
+
+                    // Show tooltip for library screen.
+                    LaunchedEffect(key1 = true) {
+                        if (viewModel.shouldShowLibraryTooltip()) {
+                            val result = snackBarHostState.showSnackbar(
+                                message = context.getString(R.string.library_tooltip),
+                                actionLabel = context.getString(R.string.got_it),
+                                duration = SnackbarDuration.Indefinite
+                            )
+
+                            when (result) {
+                                SnackbarResult.ActionPerformed -> {
+                                    viewModel.libraryTooltipDismissed()
+                                }
+                                SnackbarResult.Dismissed -> {}
+                            }
+                        }
+                    }
                 }
             }
         }

diff --git a/app/src/main/java/com/starry/myne/ui/screens/library/viewmodels/LibraryViewModel.kt b/app/src/main/java/com/starry/myne/ui/screens/library/viewmodels/LibraryViewModel.kt
@@ -41,4 +41,12 @@ class LibraryViewModel @Inject constructor(
     fun getInternalReaderSetting() = preferenceUtil.getBoolean(
         PreferenceUtil.INTERNAL_READER_BOOL, true
     )
+
+    fun shouldShowLibraryTooltip() = preferenceUtil.getBoolean(
+        PreferenceUtil.SHOW_LIBRARY_TOOLTIP_BOOL, true
+    )
+
+    fun libraryTooltipDismissed() = preferenceUtil.putBoolean(
+        PreferenceUtil.SHOW_LIBRARY_TOOLTIP_BOOL, false
+    )
 }
diff --git a/app/src/main/java/com/starry/myne/ui/screens/reader/activities/ReaderActivity.kt b/app/src/main/java/com/starry/myne/ui/screens/reader/activities/ReaderActivity.kt
@@ -28,6 +28,7 @@ import androidx.activity.compose.setContent
 import androidx.activity.viewModels
 import androidx.appcompat.app.AppCompatActivity
 import androidx.compose.animation.AnimatedVisibility
+import androidx.compose.animation.Crossfade
 import androidx.compose.animation.animateContentSize
 import androidx.compose.animation.expandVertically
 import androidx.compose.animation.fadeIn
@@ -82,6 +83,7 @@ import androidx.compose.runtime.Composable
 import androidx.compose.runtime.MutableState
 import androidx.compose.runtime.SideEffect
 import androidx.compose.runtime.collectAsState
+import androidx.compose.runtime.mutableIntStateOf
 import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.remember
 import androidx.compose.runtime.rememberCoroutineScope
@@ -252,7 +254,7 @@ class ReaderActivity : AppCompatActivity(), ReaderClickListener {
         setContent {
             MyneTheme(settingsViewModel = settingsViewModel) {
                 TransparentSystemBars()
-                val textSizeValue = remember { mutableStateOf(viewModel.getFontSize()) }
+                val textSizeValue = remember { mutableIntStateOf(viewModel.getFontSize()) }
                 val readerFontFamily = remember { mutableStateOf(viewModel.getFontFamily()) }
                 ReaderScreen(
                     viewModel = viewModel,
@@ -491,18 +493,23 @@ class ReaderActivity : AppCompatActivity(), ReaderClickListener {
                     )
                 }
             },
-            content = {
-                if (viewModel.state.isLoading) {
-                    Box(
-                        modifier = Modifier
-                            .fillMaxSize()
-                            .padding(bottom = 65.dp),
-                        contentAlignment = Alignment.Center
-                    ) {
-                        CircularProgressIndicator(color = MaterialTheme.colorScheme.primary)
+            content = { paddingValues ->
+                Crossfade(
+                    targetState = viewModel.state.isLoading,
+                    label = "reader content loading cross fade"
+                ) { loading ->
+                    if (loading) {
+                        Box(
+                            modifier = Modifier
+                                .fillMaxSize()
+                                .padding(bottom = 65.dp),
+                            contentAlignment = Alignment.Center
+                        ) {
+                            CircularProgressIndicator(color = MaterialTheme.colorScheme.primary)
+                        }
+                    } else {
+                        readerContent(paddingValues)
                     }
-                } else {
-                    readerContent(it)
                 }
             }
         )

diff --git a/app/src/main/java/com/starry/myne/ui/screens/settings/composables/SettingsScreen.kt b/app/src/main/java/com/starry/myne/ui/screens/settings/composables/SettingsScreen.kt
@@ -252,7 +252,7 @@ fun GeneralOptionsUI(viewModel: SettingsViewModel) {
                     }
                 }
             }) {
-                Text(stringResource(id = R.string.dialog_confirm_button))
+                Text(stringResource(id = R.string.confirm))
             }
         }, dismissButton = {
             TextButton(onClick = {

diff --git a/app/src/main/java/com/starry/myne/ui/screens/welcome/composables/WelcomeScreen.kt b/app/src/main/java/com/starry/myne/ui/screens/welcome/composables/WelcomeScreen.kt
@@ -213,7 +213,7 @@ fun WelcomeScreen(navController: NavController) {
                         }
                     }
                 }) {
-                    Text(stringResource(id = R.string.dialog_confirm_button))
+                    Text(stringResource(id = R.string.confirm))
                 }
             }, dismissButton = {
                 TextButton(onClick = {

diff --git a/app/src/main/java/com/starry/myne/utils/Preferencesutils.kt b/app/src/main/java/com/starry/myne/utils/Preferencesutils.kt
@@ -31,6 +31,9 @@ class PreferenceUtil(context: Context) {
         const val READER_FONT_SIZE_INT = "reader_font_size"
         const val READER_FONT_STYLE_STR = "reader_font_style"
         const val PREFERRED_BOOK_LANG_STR = "preferred_book_language"
+
+        // Temporary preference keys
+        const val SHOW_LIBRARY_TOOLTIP_BOOL = "show_library_tooltip"
     }
 
     private var prefs: SharedPreferences

diff --git a/app/src/main/res/values-ar/strings.xml b/app/src/main/res/values-ar/strings.xml
@@ -3,8 +3,10 @@
     <!-- Others Strings -->
     <string name="not_applicable">غير معروف</string>
     <string name="woops">اووبس!!</string>
-    <string name="dialog_confirm_button">تأكيد</string>
+    <string name="confirm">تأكيد</string>
     <string name="cancel">الغاء</string>
+    <string name="ok">OK</string>
+    <string name="got_it">Got it</string>
     <string name="storage_perm_error">امنح اذن التخزين من فضلك</string>
     <string name="no_app_to_handle_epub">لا يوجد اى تطبيق لفتح ملف epub</string>
     <string name="network_error">أُووبس! فشل الاتصال بالخادم.</string>
@@ -17,6 +19,9 @@
     <string name="navigation_library">المكتبة</string>
     <string name="navigation_settings">الاعدادات</string>
 
+    <!-- ToolTips -->
+    <string name="library_tooltip">TIP! Swipe library items left or right to share or view book details.</string>
+
     <!-- Welcome Screen -->
     <string name="welcome_screen_text">شكرًا لك على تثبيت Myne!\nالرجاء تحديد قارئ الكتب الإلكترونية المفضل لديك للحصول على السرعة.</string>
     <string name="welcome_screen_button">البدء</string>

diff --git a/app/src/main/res/values-cs/strings.xml b/app/src/main/res/values-cs/strings.xml
@@ -2,8 +2,10 @@
     <!-- Others Strings -->
     <string name="not_applicable">N/A</string>
     <string name="woops">"Jejda!"</string>
-    <string name="dialog_confirm_button">Potvrdit</string>
+    <string name="confirm">Potvrdit</string>
     <string name="cancel">Zrušit</string>
+    <string name="ok">OK</string>
+    <string name="got_it">Got it</string>
     <string name="storage_perm_error">Udělte prosím přístup k úložišti!</string>
     <string name="no_app_to_handle_epub">Nepodařilo se najít aplikaci, která by dokázala otevřít soubor epub.</string>
     <string name="network_error">Oops! Failed to connect with the server.</string>
@@ -16,6 +18,9 @@
     <string name="navigation_library">Knihovna</string>
     <string name="navigation_settings">Nastavení</string>
 
+    <!-- ToolTips -->
+    <string name="library_tooltip">TIP! Swipe library items left or right to share or view book details.</string>
+
     <!-- Welcome Screen -->
     <string name="welcome_screen_text">ThankYou for installing Myne!\nPlease Select your preferred e-book reader to get on speed.</string>
     <string name="welcome_screen_button">Get Started</string>

diff --git a/app/src/main/res/values-es/strings.xml b/app/src/main/res/values-es/strings.xml
@@ -3,8 +3,10 @@
     <!-- Others Strings -->
     <string name="not_applicable">N/A</string>
     <string name="woops">"¡Ups!"</string>
-    <string name="dialog_confirm_button">Confirmar</string>
+    <string name="confirm">Confirmar</string>
     <string name="cancel">Cancelar</string>
+    <string name="ok">OK</string>
+    <string name="got_it">Got it</string>
     <string name="storage_perm_error">Por favor, acepte el permiso de almacenamiento</string>
     <string name="no_app_to_handle_epub">No se ha podido encontrar ninguna aplicación para abrir el fichero epub.</string>
     <string name="network_error">Oops! Failed to connect with the server.</string>
@@ -17,6 +19,9 @@
     <string name="navigation_library">Biblioteca</string>
     <string name="navigation_settings">Ajustes</string>
 
+    <!-- ToolTips -->
+    <string name="library_tooltip">TIP! Swipe library items left or right to share or view book details.</string>
+
     <!-- Welcome Screen -->
     <string name="welcome_screen_text">ThankYou for installing Myne!\nPlease Select your preferred e-book reader to get on speed.</string>
     <string name="welcome_screen_button">Get Started</string>