#2025 feat: add button to report bug on home screen

Author: sds100

CHANGELOG.md

@@ -5,6 +5,7 @@
 ## Added
 
 - #2024 support Expert mode on all Android versions supported by Key Mapper (8.0+).
+- #2025 add report bug button to home screen menu.
 
 ## [4.0.3](https://github.com/sds100/KeyMapper/releases/tag/v4.0.3)
 

base/src/main/java/io/github/sds100/keymapper/base/home/HomeKeyMapListScreen.kt

@@ -12,6 +12,7 @@ import androidx.compose.animation.slideInVertically
 import androidx.compose.animation.slideOutHorizontally
 import androidx.compose.animation.slideOutVertically
 import androidx.compose.foundation.layout.Box
+import androidx.compose.foundation.layout.Row
 import androidx.compose.foundation.layout.WindowInsets
 import androidx.compose.foundation.layout.WindowInsetsSides
 import androidx.compose.foundation.layout.only
@@ -24,12 +25,15 @@ import androidx.compose.material.icons.Icons
 import androidx.compose.material.icons.automirrored.outlined.ArrowForward
 import androidx.compose.material.icons.outlined.Add
 import androidx.compose.material.icons.outlined.FlashlightOn
+import androidx.compose.material3.AlertDialog
 import androidx.compose.material3.ExperimentalMaterial3Api
 import androidx.compose.material3.Scaffold
 import androidx.compose.material3.SnackbarDuration
 import androidx.compose.material3.SnackbarHost
 import androidx.compose.material3.SnackbarHostState
 import androidx.compose.material3.Surface
+import androidx.compose.material3.Text
+import androidx.compose.material3.TextButton
 import androidx.compose.material3.TopAppBarDefaults
 import androidx.compose.material3.rememberModalBottomSheetState
 import androidx.compose.runtime.Composable
@@ -145,6 +149,12 @@ fun HomeKeyMapListScreen(
         )
     }
 
+    var showBugReportDialog by rememberSaveable { mutableStateOf(false) }
+
+    if (showBugReportDialog) {
+        BugReportDialog(onDismissRequest = { showBugReportDialog = false })
+    }
+
     val scrollBehavior = TopAppBarDefaults.pinnedScrollBehavior()
     val uriHandler = LocalUriHandler.current
     val ctx = LocalContext.current
@@ -216,6 +226,9 @@ fun HomeKeyMapListScreen(
                 onConstraintModeChanged = viewModel::onGroupConstraintModeChanged,
                 onFixConstraintClick = viewModel::onFixClick,
                 onKeyMapsEnabledChange = viewModel::onGroupKeyMapsEnabledChanged,
+                onReportBugClick = {
+                    showBugReportDialog = true
+                },
             )
         },
         selectionBottomSheet = {
@@ -349,6 +362,43 @@ fun HandleImportExportState(
     }
 }
 
+@Composable
+private fun BugReportDialog(onDismissRequest: () -> Unit) {
+    val ctx = LocalContext.current
+    val subject = stringResource(R.string.customer_email_subject_bug_report)
+
+    val discordLink = stringResource(R.string.url_discord_server_invite)
+    val uriHandler = LocalUriHandler.current
+    AlertDialog(
+        onDismissRequest = onDismissRequest,
+        title = { Text(stringResource(R.string.dialog_title_bug_report)) },
+        text = { Text(stringResource(R.string.dialog_message_bug_report)) },
+        confirmButton = {
+            Row {
+                TextButton(
+                    onClick = {
+                        ShareUtils.sendBugReportEmail(ctx, subject)
+                    },
+                ) {
+                    Text(stringResource(R.string.dialog_bug_report_email_button))
+                }
+                TextButton(
+                    onClick = {
+                        uriHandler.openUriSafe(ctx, discordLink)
+                    },
+                ) {
+                    Text(stringResource(R.string.dialog_bug_report_discord_button))
+                }
+            }
+        },
+        dismissButton = {
+            TextButton(onClick = onDismissRequest) {
+                Text(stringResource(R.string.neg_cancel))
+            }
+        },
+    )
+}
+
 @Composable
 private fun sampleList(): List<KeyMapListItemModel> {
     val context = LocalContext.current

base/src/main/java/io/github/sds100/keymapper/base/home/KeyMapListAppBar.kt

@@ -37,6 +37,7 @@ import androidx.compose.material.icons.automirrored.rounded.ArrowBack
 import androidx.compose.material.icons.automirrored.rounded.HelpOutline
 import androidx.compose.material.icons.automirrored.rounded.Sort
 import androidx.compose.material.icons.outlined.Lock
+import androidx.compose.material.icons.rounded.BugReport
 import androidx.compose.material.icons.rounded.Delete
 import androidx.compose.material.icons.rounded.Done
 import androidx.compose.material.icons.rounded.Edit
@@ -138,6 +139,7 @@ fun KeyMapListAppBar(
     onConstraintModeChanged: (ConstraintMode) -> Unit = {},
     onFixConstraintClick: (KMError) -> Unit = {},
     onKeyMapsEnabledChange: (Boolean) -> Unit = {},
+    onReportBugClick: () -> Unit = {},
 ) {
     BackHandler(onBack = onBackClick)
 
@@ -170,10 +172,6 @@ fun KeyMapListAppBar(
                         dropdownMenuContent = {
                             RootGroupDropdownMenu(
                                 expanded = expandedDropdown,
-                                onSortClick = {
-                                    expandedDropdown = false
-                                    onSortClick()
-                                },
                                 onSettingsClick = {
                                     expandedDropdown = false
                                     onSettingsClick()
@@ -194,6 +192,10 @@ fun KeyMapListAppBar(
                                     expandedDropdown = false
                                     onInputMethodPickerClick()
                                 },
+                                onReportBugClick = {
+                                    expandedDropdown = false
+                                    onReportBugClick()
+                                },
                                 onDismissRequest = { expandedDropdown = false },
                             )
                         },
@@ -531,9 +533,11 @@ private fun ChildGroupAppBar(
                         SelectedKeyMapsEnabled.ALL -> stringResource(
                             R.string.home_enabled_key_maps_enabled,
                         )
+
                         SelectedKeyMapsEnabled.MIXED -> stringResource(
                             R.string.home_enabled_key_maps_mixed,
                         )
+
                         SelectedKeyMapsEnabled.NONE, null -> stringResource(
                             R.string.home_enabled_key_maps_disabled,
                         )
@@ -871,12 +875,12 @@ private fun selectedTextTransition(targetState: Int, initialState: Int): Content
 @Composable
 private fun RootGroupDropdownMenu(
     expanded: Boolean,
-    onSortClick: () -> Unit = {},
     onSettingsClick: () -> Unit = {},
     onAboutClick: () -> Unit = {},
     onExportClick: () -> Unit = {},
     onImportClick: () -> Unit = {},
     onInputMethodPickerClick: () -> Unit = {},
+    onReportBugClick: () -> Unit = {},
     onDismissRequest: () -> Unit = {},
 ) {
     DropdownMenu(
@@ -908,6 +912,11 @@ private fun RootGroupDropdownMenu(
             text = { Text(stringResource(R.string.home_menu_about)) },
             onClick = onAboutClick,
         )
+        DropdownMenuItem(
+            leadingIcon = { Icon(Icons.Rounded.BugReport, contentDescription = null) },
+            text = { Text(stringResource(R.string.home_menu_report_bug)) },
+            onClick = onReportBugClick,
+        )
     }
 }
 
@@ -1037,7 +1046,7 @@ private fun KeyMapsChildGroupDarkPreview() {
 @Preview
 @Composable
 private fun KeyMapsChildGroupEditingPreview() {
-    val focusRequester = FocusRequester()
+    val focusRequester = remember { FocusRequester() }
 
     LaunchedEffect("") {
         focusRequester.requestFocus()
@@ -1075,7 +1084,7 @@ private fun KeyMapsChildGroupEditingDarkPreview() {
         keyMapsEnabled = SelectedKeyMapsEnabled.ALL,
     )
 
-    val focusRequester = FocusRequester()
+    val focusRequester = remember { FocusRequester() }
 
     LaunchedEffect("") {
         focusRequester.requestFocus()
@@ -1091,7 +1100,7 @@ private fun KeyMapsChildGroupEditingDarkPreview() {
 @Preview
 @Composable
 private fun KeyMapsChildGroupErrorPreview() {
-    val focusRequester = FocusRequester()
+    val focusRequester = remember { FocusRequester() }
 
     LaunchedEffect("") {
         focusRequester.requestFocus()

base/src/main/java/io/github/sds100/keymapper/base/utils/ShareUtils.kt

@@ -14,10 +14,35 @@ import io.github.sds100.keymapper.base.BaseMainActivity
 import io.github.sds100.keymapper.base.R
 
 object ShareUtils {
+    fun sendBugReportEmail(ctx: Context, subject: String) {
+        val body = ctx.getString(
+            R.string.customer_email_body,
+            Build.DEVICE,
+            if (Build.VERSION.SDK_INT >=
+                Build.VERSION_CODES.R
+            ) {
+                Build.VERSION.RELEASE_OR_CODENAME
+            } else {
+                Build.VERSION.RELEASE
+            },
+            ctx.applicationContext.packageManager.getPackageInfo(ctx.packageName, 0).versionName,
+        )
+
+        sendMail(
+            ctx,
+            email = ctx.getString(R.string.purchasing_contact_email),
+            subject = subject,
+            body = body,
+        )
+    }
+
     fun sendMail(ctx: Context, email: String, subject: String, body: String) {
         try {
+            // Specify the extra parameters so it works with the gmail app.
+            val uri = "mailto:$email?subject=$subject&body=$body".toUri()
+
             val intent = Intent(Intent.ACTION_SENDTO).apply {
-                data = "mailto:$email".toUri()
+                data = uri
                 putExtra(Intent.EXTRA_SUBJECT, subject)
                 putExtra(Intent.EXTRA_TEXT, body)
             }

base/src/main/res/values/strings.xml

@@ -1397,8 +1397,9 @@
     <string name="purchasing_error_assistant_not_purchased_home_screen">You must purchase the side key trigger feature! Tap on the key map and then purchase it by clicking on the shop.</string>
     <string name="purchasing_error_floating_buttons_not_purchased_home_screen">You must purchase the floating buttons feature! Tap on the key map and then purchase it by clicking on the shop.</string>
     <string name="purchasing_contact_email" translatable="false">contact@keymapper.app</string>
-    <string name="customer_email_subject" translatable="false">Key Mapper Pro query</string>
-    <string name="customer_email_body" translatable="false">Please fill the following information so I can help you.\n\n1. Device model:\n2. Android version:\n3. Key maps (make a backup in the home screen menu):\n4. Screenshot of Key Mapper home screen:\n5. Describe the problem you are having:</string>
+    <string name="customer_email_subject_pro" translatable="false">Key Mapper Pro query</string>
+    <string name="customer_email_subject_bug_report" translatable="false">Key Mapper Bug report</string>
+    <string name="customer_email_body" translatable="false">Please fill the following information so I can help you.\n\n1. Device model: %s\n2. Android version: %s\n3. Key Mapper version: %s\n4, Key maps (make a backup in the home screen menu)\n6. Screenshot of Key Mapper home screen\n6. Describe the problem you are having</string>
     <string name="purchase_thank_you_title">Thank you for supporting the app!</string>
     <string name="purchase_thank_you_message">Your purchase was successful. As a paying user of Key\u00A0Mapper you will receive priority support to help you use the app. There is now a button in the shop to contact the developer.</string>
     <string name="purchasing_not_implemented_bottom_sheet_text">The advanced triggers are paid feature but you downloaded the FOSS build of Key Mapper that does not include this closed source module or Google Play billing. Please download Key Mapper from Google Play to get access to this feature.</string>
@@ -1518,6 +1519,7 @@
     <string name="home_menu_settings">Settings</string>
     <string name="home_menu_delete_group">Delete group</string>
     <string name="home_menu_about">About</string>
+    <string name="home_menu_report_bug">Report bug</string>
     <string name="home_menu_export">Export all</string>
     <string name="home_menu_import">Import</string>
     <string name="home_menu_input_method_picker">Choose keyboard</string>
@@ -1891,5 +1893,9 @@
     <string name="floating_buttons_review_card_message">We would love to know! Please consider leaving a review on Google Play to help others discover this feature. ❤️</string>
     <string name="floating_buttons_review_card_dismiss">Dismiss</string>
     <string name="error_write_evdev_event_failed">Write evdev event failed</string>
+    <string name="dialog_title_bug_report">Report bug</string>
+    <string name="dialog_message_bug_report">We would prefer it if you report your bug to the Discord server so other users can help you. Otherwise, you can email us at contact@keymapper.app.</string>
+    <string name="dialog_bug_report_discord_button">Open Discord</string>
+    <string name="dialog_bug_report_email_button">Email us</string>
 
 </resources>