Skip map annotation callout when voiceover is enabled

Fixes OneBusAway#526
ualch9 · Sep 19, 2021 · c75ca8d · c75ca8d
1 parent 99b9a59
commit c75ca8d
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/OBAKit/Mapping/MapViewController.swift b/OBAKit/Mapping/MapViewController.swift
@@ -420,6 +420,12 @@ public class MapViewController: UIViewController,
             present(alert, animated: true) {
                 mapView.deselectAnnotation(view.annotation, animated: true)
             }
+        } else if let stop = view.annotation as? Stop, UIAccessibility.isVoiceOverRunning {
+            // When VoiceOver is running, StopAnnotationView does not display a callout due to
+            // VoiceOver limitations with MKMapView. Therefore, we should skip any callouts
+            // and just go directly to pushing the stop onto the navigation stack.
+            application.analytics?.reportEvent?(.userAction, label: AnalyticsLabels.mapStopAnnotationTapped, value: nil)
+            show(stop: stop)
         }
     }
 
@@ -440,7 +446,6 @@ public class MapViewController: UIViewController,
         }
 
         application.analytics?.reportEvent?(.userAction, label: AnalyticsLabels.mapStopAnnotationTapped, value: nil)
-
         show(stop: stop)
     }
 

diff --git a/OBAKit/Mapping/StopAnnotationView.swift b/OBAKit/Mapping/StopAnnotationView.swift
@@ -73,7 +73,9 @@ class StopAnnotationView: MKAnnotationView {
         rightCalloutAccessoryView = UIButton.chevronButton
 
         annotationSize = ThemeMetrics.defaultMapAnnotationSize
-        canShowCallout = true
+        updateAccessibility()
+
+        NotificationCenter.default.addObserver(self, selector: #selector(voiceoverStatusDidChange), name: UIAccessibility.voiceOverStatusDidChangeNotification, object: nil)
     }
 
     required init?(coder aDecoder: NSCoder) { fatalError("init(coder:) has not been implemented") }
@@ -136,4 +138,15 @@ class StopAnnotationView: MKAnnotationView {
 
     /// Foreground color for text written directly onto the map as part of this annotation view.
     public var mapTextColor: UIColor = ThemeColors.shared.mapText
+
+    // MARK: - Accessibility
+    @objc fileprivate func voiceoverStatusDidChange(_ notification: Notification) {
+        updateAccessibility()
+    }
+
+    fileprivate func updateAccessibility() {
+        // Callouts are finicky when in VoiceOver. When VoiceOver is running,
+        // we should skip the callout and push directly to the annotation's destination view.
+        canShowCallout = !UIAccessibility.isVoiceOverRunning
+    }
 }