Check UISwitch state using combination of trait and value

Author: NickEntin

Example/AccessibilitySnapshot/SwitchControlViewController.swift

@@ -91,26 +91,36 @@ private extension SwitchControlViewController {
 
             switchControls.forEach { addSubview($0) }
 
+            let switchTrait = UIAccessibilityTraits(rawValue: 0x0020000000000000)
+
             // Add a fake switch that has the switch button trait only, but is not a UISwitch.
-            fakeSwitchView.isAccessibilityElement = true
-            fakeSwitchView.accessibilityLabel = "Fake Label"
-            fakeSwitchView.accessibilityValue = "Value"
-            fakeSwitchView.accessibilityTraits.insert(UIAccessibilityTraits(rawValue: 0x0020000000000000))
-            fakeSwitchView.frame.size = .init(width: 48, height: 32)
-            fakeSwitchView.backgroundColor = .lightGray
-            fakeSwitchView.layer.cornerRadius = 16
-            addSubview(fakeSwitchView)
-
-            // Add a fake switch that has the switch button and button traits, but is not a UISwitch.
-            fakeSwitchButton.isAccessibilityElement = true
-            fakeSwitchButton.accessibilityLabel = "Fake Label"
-            fakeSwitchButton.accessibilityValue = "Value"
-            fakeSwitchButton.accessibilityTraits.insert(.button)
-            fakeSwitchButton.accessibilityTraits.insert(UIAccessibilityTraits(rawValue: 0x0020000000000000))
-            fakeSwitchButton.frame.size = .init(width: 48, height: 32)
-            fakeSwitchButton.backgroundColor = .lightGray
-            fakeSwitchButton.layer.cornerRadius = 16
-            addSubview(fakeSwitchButton)
+            for fakeSwitchView in fakeSwitchViews {
+                fakeSwitchView.isAccessibilityElement = true
+                fakeSwitchView.accessibilityLabel = "Fake Label"
+                fakeSwitchView.frame.size = .init(width: 48, height: 32)
+                fakeSwitchView.backgroundColor = .lightGray
+                fakeSwitchView.layer.cornerRadius = 16
+            }
+
+            fakeSwitchViews[0].accessibilityValue = "1"
+            fakeSwitchViews[0].accessibilityTraits = [switchTrait, .button]
+
+            fakeSwitchViews[1].accessibilityValue = "0"
+            fakeSwitchViews[1].accessibilityTraits = [switchTrait, .button]
+
+            fakeSwitchViews[2].accessibilityValue = "2"
+            fakeSwitchViews[2].accessibilityTraits = [switchTrait, .button]
+
+            fakeSwitchViews[3].accessibilityValue = "1"
+            fakeSwitchViews[3].accessibilityTraits = [switchTrait]
+
+            fakeSwitchViews[4].accessibilityValue = "3"
+            fakeSwitchViews[4].accessibilityTraits = [switchTrait]
+
+            fakeSwitchViews[5].accessibilityValue = "Value"
+            fakeSwitchViews[5].accessibilityTraits = [.button, switchTrait]
+
+            fakeSwitchViews.forEach { addSubview($0) }
         }
 
         @available(*, unavailable)
@@ -122,11 +132,8 @@ private extension SwitchControlViewController {
 
         private let switchControls: [UISwitch] = (0..<9).map { _ in UISwitch() }
 
-        /// UIView with the switch button trait that acts like a switch, but is not a UISwitch.
-        private let fakeSwitchView: UIView = .init()
-
-        /// UIView with the button and switch button traits that acts like a switch, but is not a UISwitch.
-        private let fakeSwitchButton: UIView = .init()
+        /// `UIView`s with the switch button trait that act like a switch, but aren't actually switches.
+        private let fakeSwitchViews: [UIView] = (0..<6).map { _ in UIView() }
 
         // MARK: - UIView
 
@@ -136,18 +143,10 @@ private extension SwitchControlViewController {
             let statusBarHeight = window?.windowScene?.statusBarManager?.statusBarFrame.height ?? 0
 
             var distributionSpecifiers: [ViewDistributionSpecifying] = [ statusBarHeight.fixed, 1.flexible ]
-            for subview in switchControls {
+            for subview in (switchControls + fakeSwitchViews) {
                 distributionSpecifiers.append(subview)
                 distributionSpecifiers.append(1.flexible)
             }
-            distributionSpecifiers.append(
-                contentsOf: [
-                    fakeSwitchView.distributionItem,
-                    1.flexible,
-                    fakeSwitchButton.distributionItem,
-                    1.flexible,
-                ]
-            )
             applyVerticalSubviewDistribution(distributionSpecifiers)
         }
 

Example/SnapshotTests/ReferenceImages/_64/SnapshotTests.AccessibilitySnapshotTests/[email protected]

@@ -35,10 +35,13 @@
 "trait.search_field.description" = "Suchfeld.";
 
 /* Description for the 'switch button' accessibility trait, when the switch is on */
-"trait.switch_button.state_on.description" = "Umschalttaste. Ein.";
+"trait.switch_button.state_on.description" = "Ein.";
 
 /* Description for the 'switch button' accessibility trait, when the switch is off */
-"trait.switch_button.state_off.description" = "Umschalttaste. Aus.";
+"trait.switch_button.state_off.description" = "Aus.";
+
+/* Description for the 'switch button' accessibility trait, when the switch is in a mixed state */
+"trait.switch_button.state_mixed.description" = "Gemischt.";
 
 /* Description for the 'switch button' accessibility trait, when the state of the switch cannot be determined */
 "trait.switch_button.state_unspecified.description" = "Umschalttaste.";

Example/SnapshotTests/ReferenceImages/_64/SnapshotTests.AccessibilitySnapshotTests/[email protected]

@@ -35,10 +35,13 @@
 "trait.search_field.description" = "Search Field.";
 
 /* Description for the 'switch button' accessibility trait, when the switch is on */
-"trait.switch_button.state_on.description" = "Switch Button. On.";
+"trait.switch_button.state_on.description" = "On.";
 
 /* Description for the 'switch button' accessibility trait, when the switch is off */
-"trait.switch_button.state_off.description" = "Switch Button. Off.";
+"trait.switch_button.state_off.description" = "Off.";
+
+/* Description for the 'switch button' accessibility trait, when the switch is in a mixed state */
+"trait.switch_button.state_mixed.description" = "Mixed.";
 
 /* Description for the 'switch button' accessibility trait, when the state of the switch cannot be determined */
 "trait.switch_button.state_unspecified.description" = "Switch Button.";

Example/SnapshotTests/ReferenceImages/_64/SnapshotTests.AccessibilitySnapshotTests/[email protected]

@@ -35,10 +35,13 @@
 "trait.search_field.description" = "Поле поиска.";
 
 /* Description for the 'switch button' accessibility trait, when the switch is on */
-"trait.switch_button.state_on.description" = "Кнопка-переключатель. Вкл.";
+"trait.switch_button.state_on.description" = "Вкл.";
 
 /* Description for the 'switch button' accessibility trait, when the switch is off */
-"trait.switch_button.state_off.description" = "Кнопка-переключатель. Выкл.";
+"trait.switch_button.state_off.description" = "Выкл.";
+
+/* Description for the 'switch button' accessibility trait, when the switch is in a mixed state */
+"trait.switch_button.state_mixed.description" = "Смешанно.";
 
 /* Description for the 'switch button' accessibility trait, when the state of the switch cannot be determined */
 "trait.switch_button.state_unspecified.description" = "Кнопка-переключатель.";

Sources/AccessibilitySnapshot/Core/Swift/Assets/de.lproj/Localizable.strings

@@ -107,19 +107,23 @@ extension NSObject {
         }
 
         if accessibilityTraits.contains(.switchButton) {
-            if let `self` = self as? UISwitch {
-                if self.isOn {
-                    traitSpecifiers.append(strings.switchButtonOnTraitName)
-                } else {
-                    traitSpecifiers.append(strings.switchButtonOffTraitName)
-                }
+            if accessibilityTraits.contains(.button) {
+                // An element can have the private switch button trait without being a UISwitch (for example, by passing
+                // through the traits of a contained switch). In this case, VoiceOver will still read the "Switch
+                // Button." trait, but only if the element's traits also include the `.button` trait.
+                traitSpecifiers.append(strings.switchButtonTraitName)
+            }
 
-            } else if accessibilityTraits.contains(.button) {
-                // An element can have the private switch button trait without being a UISwitch (for example, by passing through
-                // the traits of a contained switch). In this case, VoiceOver will still read the "Switch Button." trait, but
-                // will not read whether or not the switch is turned on. If the element's traits do not also include the `.button`
-                // trait, VoiceOver will not read the trait description.
-                traitSpecifiers.append(strings.switchButtonStatelessTraitName)
+            switch accessibilityValue {
+            case "1":
+                traitSpecifiers.append(strings.switchButtonOnStateName)
+            case "0":
+                traitSpecifiers.append(strings.switchButtonOffStateName)
+            case "2":
+                traitSpecifiers.append(strings.switchButtonMixedStateName)
+            default:
+                // When the switch button trait is set, unknown accessibility values are omitted from the description.
+                break
             }
         }
 
@@ -304,11 +308,13 @@ extension NSObject {
 
         let searchFieldTraitName: String
 
-        let switchButtonOnTraitName: String
+        let switchButtonTraitName: String
+
+        let switchButtonOnStateName: String
 
-        let switchButtonOffTraitName: String
+        let switchButtonOffStateName: String
 
-        let switchButtonStatelessTraitName: String
+        let switchButtonMixedStateName: String
 
         let switchButtonTraitHint: String
 
@@ -396,19 +402,24 @@ extension NSObject {
                 comment: "Description for the 'search field' accessibility trait",
                 locale: locale
             )
-            self.switchButtonOnTraitName = "Switch Button. On.".localized(
+            self.switchButtonTraitName = "Switch Button.".localized(
+                key: "trait.switch_button.state_unspecified.description",
+                comment: "Description for the 'switch button' accessibility trait, when the state of the switch cannot be determined",
+                locale: locale
+            )
+            self.switchButtonOnStateName = "On.".localized(
                 key: "trait.switch_button.state_on.description",
                 comment: "Description for the 'switch button' accessibility trait, when the switch is on",
                 locale: locale
             )
-            self.switchButtonOffTraitName = "Switch Button. Off.".localized(
+            self.switchButtonOffStateName = "Off.".localized(
                 key: "trait.switch_button.state_off.description",
                 comment: "Description for the 'switch button' accessibility trait, when the switch is off",
                 locale: locale
             )
-            self.switchButtonStatelessTraitName = "Switch Button.".localized(
-                key: "trait.switch_button.state_unspecified.description",
-                comment: "Description for the 'switch button' accessibility trait, when the state of the switch cannot be determined",
+            self.switchButtonMixedStateName = "Mixed.".localized(
+                key: "trait.switch_button.state_mixed.description",
+                comment: "Description for the 'switch button' accessibility trait, when the switch is in a mixed state",
                 locale: locale
             )
             self.switchButtonTraitHint = "Double tap to toggle setting.".localized(