Localize content descriptions

TimPushkin · TimPushkin · commit c2b81cf525fb · 2023-06-27T16:21:15.000+03:00
diff --git a/app/src/main/java/ru/spbu/depnav/ui/map/FloorSwitch.kt b/app/src/main/java/ru/spbu/depnav/ui/map/FloorSwitch.kt
@@ -38,7 +38,9 @@ import androidx.compose.material3.Text
 import androidx.compose.runtime.Composable
 import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
+import androidx.compose.ui.res.stringResource
 import androidx.compose.ui.tooling.preview.Preview
+import ru.spbu.depnav.R
 import ru.spbu.depnav.ui.theme.DepNavTheme
 
 /** Two buttons to switch the current map one floor up or down. */
@@ -60,7 +62,10 @@ fun FloorSwitch(
                 onClick = { onClick(floor + 1) },
                 enabled = floor < maxFloor
             ) {
-                Icon(Icons.Rounded.KeyboardArrowUp, contentDescription = "Up arrow")
+                Icon(
+                    Icons.Rounded.KeyboardArrowUp,
+                    contentDescription = stringResource(R.string.label_to_floor_above)
+                )
             }
 
             AnimatedContent(
@@ -82,7 +87,10 @@ fun FloorSwitch(
                 onClick = { onClick(floor - 1) },
                 enabled = floor > minFloor
             ) {
-                Icon(Icons.Rounded.KeyboardArrowDown, contentDescription = "Down arrow")
+                Icon(
+                    Icons.Rounded.KeyboardArrowDown,
+                    contentDescription = stringResource(R.string.label_to_floor_below)
+                )
             }
         }
     }
diff --git a/app/src/main/java/ru/spbu/depnav/ui/map/MarkerView.kt b/app/src/main/java/ru/spbu/depnav/ui/map/MarkerView.kt
@@ -29,6 +29,7 @@ import androidx.compose.ui.draw.alpha
 import androidx.compose.ui.graphics.Shadow
 import androidx.compose.ui.graphics.painter.Painter
 import androidx.compose.ui.res.painterResource
+import androidx.compose.ui.res.stringResource
 import androidx.compose.ui.text.style.TextDecoration
 import androidx.compose.ui.tooling.preview.Preview
 import androidx.compose.ui.unit.dp
@@ -52,7 +53,7 @@ fun MarkerView(
         MarkerIcon(
             painter = painterResource(R.drawable.mrk_room),
             faded = isClosed,
-            contentDescription = "Room",
+            contentDescription = stringResource(R.string.label_room_icon),
             modifier = modifier
         )
     } else {
@@ -65,55 +66,55 @@ fun MarkerView(
     MarkerType.ENTRANCE -> MarkerIcon(
         painter = painterResource(R.drawable.mrk_entrance),
         faded = isClosed,
-        contentDescription = "Entrance",
+        contentDescription = stringResource(R.string.label_entrance_icon),
         modifier = modifier
     )
     MarkerType.STAIRS_UP -> MarkerIcon(
         painter = painterResource(R.drawable.mrk_stairs_up),
         faded = isClosed,
-        contentDescription = "Stairs up",
+        contentDescription = stringResource(R.string.label_stairs_up_icon),
         modifier = modifier
     )
     MarkerType.STAIRS_DOWN -> MarkerIcon(
         painter = painterResource(R.drawable.mrk_stairs_down),
         faded = isClosed,
-        contentDescription = "Stairs down",
+        contentDescription = stringResource(R.string.label_stairs_down_icon),
         modifier = modifier
     )
     MarkerType.STAIRS_BOTH -> MarkerIcon(
         painter = painterResource(R.drawable.mrk_stairs),
         faded = isClosed,
-        contentDescription = "Stairs up and down",
+        contentDescription = stringResource(R.string.label_stairs_both_icon),
         modifier = modifier
     )
     MarkerType.ELEVATOR -> MarkerIcon(
         painter = painterResource(R.drawable.mrk_elevator),
         faded = isClosed,
-        contentDescription = "Elevator",
+        contentDescription = stringResource(R.string.label_elevator_icon),
         modifier = modifier
     )
     MarkerType.WC_MAN -> MarkerIcon(
         painter = painterResource(R.drawable.mrk_wc_man),
         faded = isClosed,
-        contentDescription = "Men's room",
+        contentDescription = stringResource(R.string.label_wc_man_icon),
         modifier = modifier
     )
     MarkerType.WC_WOMAN -> MarkerIcon(
         painter = painterResource(R.drawable.mrk_wc_woman),
         faded = isClosed,
-        contentDescription = "Women's room",
+        contentDescription = stringResource(R.string.label_wc_woman_icon),
         modifier = modifier
     )
     MarkerType.WC -> MarkerIcon(
         painter = painterResource(R.drawable.mrk_wc),
         faded = isClosed,
-        contentDescription = "Restroom",
+        contentDescription = stringResource(R.string.label_wc_icon),
         modifier = modifier
     )
     MarkerType.OTHER -> MarkerIcon(
         painter = painterResource(R.drawable.mrk_other),
         faded = isClosed,
-        contentDescription = "Other marker",
+        contentDescription = stringResource(R.string.label_other_icon),
         modifier = modifier
     )
 }
diff --git a/app/src/main/java/ru/spbu/depnav/ui/map/Pin.kt b/app/src/main/java/ru/spbu/depnav/ui/map/Pin.kt
@@ -25,6 +25,7 @@ import androidx.compose.material3.MaterialTheme
 import androidx.compose.runtime.Composable
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.res.painterResource
+import androidx.compose.ui.res.stringResource
 import androidx.compose.ui.unit.dp
 import ru.spbu.depnav.R
 
@@ -35,7 +36,7 @@ private val SIZE = 30.dp
 fun Pin(modifier: Modifier = Modifier) {
     Icon(
         painter = painterResource(R.drawable.pin),
-        contentDescription = "Pin",
+        contentDescription = stringResource(R.string.label_selected_place),
         modifier = Modifier
             .size(SIZE)
             .offset(y = -SIZE / 2)
diff --git a/app/src/main/java/ru/spbu/depnav/ui/map/TopButton.kt b/app/src/main/java/ru/spbu/depnav/ui/map/TopButton.kt
@@ -39,7 +39,9 @@ import androidx.compose.runtime.CompositionLocalProvider
 import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.platform.LocalViewConfiguration
+import androidx.compose.ui.res.stringResource
 import androidx.compose.ui.tooling.preview.Preview
+import ru.spbu.depnav.R
 import ru.spbu.depnav.ui.theme.DepNavTheme
 
 /** Button with a search icon, text, and additional nested buttons. */
@@ -62,7 +64,10 @@ fun TopButton(
                 modifier = Modifier.size(LocalViewConfiguration.current.minimumTouchTargetSize),
                 contentAlignment = Alignment.Center
             ) {
-                Icon(Icons.Rounded.Search, contentDescription = "Search")
+                Icon(
+                    Icons.Rounded.Search,
+                    contentDescription = stringResource(R.string.label_search)
+                )
             }
 
             CompositionLocalProvider(
@@ -78,11 +83,17 @@ fun TopButton(
             }
 
             IconButton(onClick = onInfoClick) {
-                Icon(Icons.Rounded.Info, contentDescription = "Open map info")
+                Icon(
+                    Icons.Rounded.Info,
+                    contentDescription = stringResource(R.string.label_open_map_info)
+                )
             }
 
             IconButton(onClick = onSettingsClick) {
-                Icon(Icons.Rounded.Settings, contentDescription = "Open settings")
+                Icon(
+                    Icons.Rounded.Settings,
+                    contentDescription = stringResource(R.string.label_open_settings)
+                )
             }
         }
     }
diff --git a/app/src/main/java/ru/spbu/depnav/ui/map/ZoomInHint.kt b/app/src/main/java/ru/spbu/depnav/ui/map/ZoomInHint.kt
@@ -53,7 +53,7 @@ fun ZoomInHint() {
         ) {
             Icon(
                 painter = painterResource(R.drawable.ic_pinch_zoom_in),
-                contentDescription = "Pinch to zoom in",
+                contentDescription = null,
                 modifier = Modifier.size(
                     with(LocalDensity.current) {
                         MaterialTheme.typography.bodySmall.fontSize.toDp() * 2
diff --git a/app/src/main/java/ru/spbu/depnav/ui/search/SearchField.kt b/app/src/main/java/ru/spbu/depnav/ui/search/SearchField.kt
@@ -48,7 +48,9 @@ import androidx.compose.ui.focus.focusRequester
 import androidx.compose.ui.graphics.Color
 import androidx.compose.ui.graphics.RectangleShape
 import androidx.compose.ui.platform.LocalSoftwareKeyboardController
+import androidx.compose.ui.res.stringResource
 import androidx.compose.ui.text.input.ImeAction
+import ru.spbu.depnav.R
 
 /** Text field with a search icon. */
 @Composable
@@ -67,7 +69,10 @@ fun SearchField(
         val keyboard = LocalSoftwareKeyboardController.current
 
         IconButton(onClick = onBackClick) {
-            Icon(imageVector = Icons.Rounded.ArrowBack, contentDescription = "Navigate back")
+            Icon(
+                imageVector = Icons.Rounded.ArrowBack,
+                contentDescription = stringResource(R.string.label_navigate_back)
+            )
         }
 
         TextField(
@@ -92,7 +97,10 @@ fun SearchField(
                             onClear()
                         }
                     ) {
-                        Icon(Icons.Rounded.Close, contentDescription = "Clear field")
+                        Icon(
+                            Icons.Rounded.Close,
+                            contentDescription = stringResource(R.string.label_clear_text_field)
+                        )
                     }
                 }
             },
diff --git a/app/src/main/java/ru/spbu/depnav/ui/search/SearchResults.kt b/app/src/main/java/ru/spbu/depnav/ui/search/SearchResults.kt
@@ -87,7 +87,7 @@ fun SearchResults(
                         ) {
                             Icon(
                                 painter = painterResource(R.drawable.ic_searched_for),
-                                contentDescription = "Search history",
+                                contentDescription = null,
                                 modifier = Modifier.size(28.dp)
                             )
                         }
diff --git a/app/src/main/res/values-ru/strings.xml b/app/src/main/res/values-ru/strings.xml
@@ -31,4 +31,24 @@
 
     <!-- Etc -->
     <string name="zoom_in_to_see_markers">Приблизьте, чтобы увидеть метки</string>
+
+    <!-- Content descriptions for accessibility-->
+    <string name="label_to_floor_above">На этаж выше</string>
+    <string name="label_to_floor_below">На этаж ниже</string>
+    <string name="label_room_icon">Помещение</string>
+    <string name="label_entrance_icon">Вход</string>
+    <string name="label_stairs_up_icon">Лестница вверх</string>
+    <string name="label_stairs_down_icon">Лестница вниз</string>
+    <string name="label_stairs_both_icon">Лестница в оба направления</string>
+    <string name="label_elevator_icon">Лифт</string>
+    <string name="label_wc_man_icon">Мужской туалет</string>
+    <string name="label_wc_woman_icon">Женский туалет</string>
+    <string name="label_wc_icon">Общий туалет</string>
+    <string name="label_other_icon">Иное место</string>
+    <string name="label_selected_place">Выбранное место</string>
+    <string name="label_search">Искать</string>
+    <string name="label_open_map_info">Открыть информацию о карте</string>
+    <string name="label_open_settings">Открыть настройки</string>
+    <string name="label_navigate_back">Вернуться назад</string>
+    <string name="label_clear_text_field">Очистить поле ввода</string>
 </resources>
diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml
@@ -35,4 +35,24 @@
 
     <!-- Etc -->
     <string name="zoom_in_to_see_markers">Zoom in to see markers</string>
+
+    <!-- Content descriptions for accessibility-->
+    <string name="label_to_floor_above">To the floor above</string>
+    <string name="label_to_floor_below">To the floor below</string>
+    <string name="label_room_icon">Room</string>
+    <string name="label_entrance_icon">Entrance</string>
+    <string name="label_stairs_up_icon">Stairs to the floor above</string>
+    <string name="label_stairs_down_icon">Stairs to the floor below</string>
+    <string name="label_stairs_both_icon">Stairs in both directions</string>
+    <string name="label_elevator_icon">Elevator</string>
+    <string name="label_wc_man_icon">Men\'s restroom</string>
+    <string name="label_wc_woman_icon">Women\'s restroom</string>
+    <string name="label_wc_icon">Unisex restroom</string>
+    <string name="label_other_icon">Miscellaneous place</string>
+    <string name="label_selected_place">Selected place</string>
+    <string name="label_search">Search</string>
+    <string name="label_open_map_info">Open map info</string>
+    <string name="label_open_settings">Open settings</string>
+    <string name="label_navigate_back">Navigate back</string>
+    <string name="label_clear_text_field">Clear text field</string>
 </resources>

Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@ fun SearchResults(`
`87`	`87`	`) {`
`88`	`88`	`Icon(`
`89`	`89`	`painter = painterResource(R.drawable.ic_searched_for),`
`90`		`- contentDescription = "Search history",`
	`90`	`+ contentDescription = null,`
`91`	`91`	`modifier = Modifier.size(28.dp)`
`92`	`92`	`)`
`93`	`93`	`}`