feat: improve voiceover posts for countdown / instructions (#15)

Author: atierian

Sources/FaceLiveness/Utilities/LocalizedStringKey+Liveness.swift

@@ -68,6 +68,16 @@ extension LocalizedStringKey {
         "amplify_ui_liveness_get_ready_begin_check"
     )
 
+    /// en = "Illustration demonstrating good fit of face in oval."
+    static let get_ready_illustration_good_fit_a11y = LocalizedStringKey(
+        "amplify_ui_liveness_get_ready_illustration_good_fit_a11y"
+    )
+
+    /// en = "Illustration demonstrating face too far from screen."
+    static let get_ready_illustration_too_far_a11y = LocalizedStringKey(
+        "amplify_ui_liveness_get_ready_illustration_too_far_a11y"
+    )
+
     /// en = "REC"
     static let challenge_recording_indicator_label = LocalizedStringKey(
         "amplify_ui_liveness_challenge_recording_indicator_label"
@@ -85,7 +95,7 @@ extension LocalizedStringKey {
 
     /// en = "Move back"
     static let challenge_instruction_move_face_back = LocalizedStringKey(
-        "amplify_ui_liveness_challenge_instruction_move_face_bqck"
+        "amplify_ui_liveness_challenge_instruction_move_face_back"
     )
 
     /// en = "Move closer"

Sources/FaceLiveness/Views/Countdown/CountdownInstructionContainerView.swift

@@ -35,6 +35,16 @@ struct CountdownInstructionContainerView: View {
                 text: .challenge_verifying,
                 backgroundColor: .livenessBackground
             )
+            .onAppear {
+                UIAccessibility.post(
+                    notification: .announcement,
+                    argument: NSLocalizedString(
+                        "amplify_ui_liveness_challenge_verifying",
+                        bundle: .module,
+                        comment: ""
+                    )
+                )
+            }
         default:
             EmptyView()
         }

Sources/FaceLiveness/Views/Countdown/CountdownView+ViewModel.swift

@@ -42,11 +42,16 @@ extension CountdownView {
 
         deinit { timerCancellable?.cancel() }
 
-        func timerInvoked() {
+        private func setAccessibilityValue() {
+            guard remaining >= 1 else { return }
             if remaining != initialDuration
                 && Int(floor(remaining)) != Int(floor(remaining - tickRate)) {
                 timerAccessibilityValue = String(Int(remaining))
             }
+        }
+
+        func timerInvoked() {
+            setAccessibilityValue()
             remaining -= tickRate
             percentage -= rate
             if remaining <= 0 {

Sources/FaceLiveness/Views/Countdown/CountdownView.swift

@@ -38,12 +38,15 @@ struct CountdownView: View {
                 .animation(.linear, value: viewModel.percentage)
 
             Text(viewModel.formatted(remaining: viewModel.remaining))
-                .accessibilityValue(viewModel.formatted(remaining: viewModel.remaining))
+                .accessibilityHidden(true)
                 .font(.system(size: 24, weight: .semibold))
         }
         .onReceive(viewModel.timer) { _ in
             viewModel.timerInvoked()
         }
+        .onReceive(viewModel.$timerAccessibilityValue) { value in
+            UIAccessibility.post(notification: .announcement, argument: value)
+        }
     }
 }
 

Sources/FaceLiveness/Views/GetReadyPage/GetReadyPageView.swift

@@ -28,6 +28,7 @@ struct GetReadyPageView: View {
                 VStack(alignment: .leading) {
                     Text(.get_ready_page_title, bundle: .module)
                         .font(.system(size: 34, weight: .semibold))
+                        .accessibilityAddTraits(.isHeader)
                         .padding(.bottom, 8)
 
                     Text(.get_ready_page_description, bundle: .module)
@@ -38,13 +39,15 @@ struct GetReadyPageView: View {
                         bodyText: .get_ready_photosensitivity_description,
                         popoverContent: { photosensitivityWarningPopoverContent }
                     )
-                        .padding(.bottom, 8)
+                    .accessibilityElement(children: .combine)
+                    .padding(.bottom, 8)
 
                     Text(.get_ready_steps_title, bundle: .module)
                         .fontWeight(.semibold)
                         .padding(.bottom, 16)
 
                     OvalIllustrationExamples()
+                        .accessibilityHidden(true)
                         .padding(.bottom)
 
                     steps()
@@ -118,8 +121,13 @@ struct GetReadyPageView: View {
             spacing: 16
         ) {
             step(number: 1, text: .get_ready_fit_face)
+                .accessibilityElement(children: .combine)
+
             step(number: 2, text: .get_ready_face_not_covered)
+                .accessibilityElement(children: .combine)
+
             step(number: 3, text: .get_ready_lighting)
+                .accessibilityElement(children: .combine)
         }
     }
 }

Sources/FaceLiveness/Views/GetReadyPage/OvalIllustrationExamples.swift

@@ -17,6 +17,8 @@ struct OvalIllustrationExamples: View {
                     secondaryColor: .hex("#D6F5DB"),
                     illustration: { Image("illustration_face_good_fit", bundle: .module) }
                 )
+                .accessibilityElement(children: .ignore)
+                .accessibilityLabel(Text(.get_ready_illustration_good_fit_a11y, bundle: .module))
 
                 OvalIllustrationView(
                     icon: .xmark(backgroundColor: .hex("#660000")),
@@ -25,6 +27,8 @@ struct OvalIllustrationExamples: View {
                     secondaryColor: .hex("#F5BCBC"),
                     illustration: { Image("illustration_face_too_far", bundle: .module) }
                 )
+                .accessibilityElement(children: .ignore)
+                .accessibilityLabel(Text(.get_ready_illustration_too_far_a11y, bundle: .module))
 
                 Spacer()
         }

Sources/FaceLiveness/Views/Instruction/InstructionContainerView.swift

@@ -6,6 +6,7 @@
 //
 
 import SwiftUI
+import Combine
 
 struct InstructionContainerView: View {
     @ObservedObject var viewModel: FaceLivenessDetectionViewModel
@@ -19,6 +20,16 @@ struct InstructionContainerView: View {
                 textColor: .livenessPrimaryLabel,
                 font: .title
             )
+            .onAppear {
+                UIAccessibility.post(
+                    notification: .announcement,
+                    argument: NSLocalizedString(
+                        "amplify_ui_liveness_challenge_instruction_hold_still",
+                        bundle: .module,
+                        comment: ""
+                    )
+                )
+            }
 
         case .awaitingFaceInOvalMatch(.faceTooClose, _):
             InstructionView(
@@ -27,6 +38,16 @@ struct InstructionContainerView: View {
                 textColor: .livenessErrorLabel,
                 font: .title
             )
+            .onAppear {
+                UIAccessibility.post(
+                    notification: .announcement,
+                    argument: NSLocalizedString(
+                        "amplify_ui_liveness_challenge_instruction_move_face_back",
+                        bundle: .module,
+                        comment: ""
+                    )
+                )
+            }
 
         case .awaitingFaceInOvalMatch(let reason, let percentage):
             InstructionView(
@@ -51,6 +72,16 @@ struct InstructionContainerView: View {
                 textColor: .livenessPrimaryLabel,
                 font: .title
             )
+            .onAppear {
+                UIAccessibility.post(
+                    notification: .announcement,
+                    argument: NSLocalizedString(
+                        "amplify_ui_liveness_challenge_instruction_move_face_closer",
+                        bundle: .module,
+                        comment: ""
+                    )
+                )
+            }
 
             ProgressBarView(
                 emptyColor: .white,

Sources/FaceLiveness/Views/Liveness/FaceLivenessDetectionView.swift

@@ -178,7 +178,6 @@ public struct FaceLivenessDetectorView: View {
             requestCameraPermission()
         case .authorized:
             displayState = .displayingLiveness
-            UIScreen.main.brightness = 1.0
         case .restricted, .denied:
             alertCameraAccessNeeded()
         @unknown default:

Sources/FaceLiveness/Views/Liveness/FaceLivenessDetectionViewModel+FaceDetectionResultHandler.swift

@@ -16,19 +16,10 @@ extension FaceLivenessDetectionViewModel: FaceDetectionResultHandler {
     func process(newResult: FaceDetectionResult) {
         switch newResult {
         case .noFace:
-            switch livenessState.state {
-            case .pendingFacePreparedConfirmation:
+            if case .pendingFacePreparedConfirmation = livenessState.state {
                 DispatchQueue.main.async {
                     self.livenessState.faceNotPrepared(reason: .noFace)
                 }
-                return
-            case .countingDown:
-                DispatchQueue.main.async {
-                    self.livenessState.unrecoverableStateEncountered(
-                        .invalidFaceMovementDuringCountdown
-                    )
-                }
-            default: return
             }
         case .multipleFaces:
             if case .pendingFacePreparedConfirmation = livenessState.state {