Fix issue where text fields do not have "text field" or a hint in their description

Author: David Brunow

Example/AccessibilitySnapshot.xcodeproj/project.pbxproj

@@ -7,6 +7,7 @@
 	objects = {
 
 /* Begin PBXBuildFile section */
+		1104A8CF2B580AC500B6715F /* SwiftUITextEntry.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1104A8CE2B580AC500B6715F /* SwiftUITextEntry.swift */; };
 		1635CE4E251EAC6700907101 /* SnapshotTestingTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1635CE4D251EAC6700907101 /* SnapshotTestingTests.swift */; };
 		3D04B6D6211558B0006218A4 /* AccessibilityViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3D04B6D5211558B0006218A4 /* AccessibilityViewController.swift */; };
 		3D04B6D921155942006218A4 /* LabelAccessibilityPropertiesViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3D04B6D821155942006218A4 /* LabelAccessibilityPropertiesViewController.swift */; };
@@ -77,6 +78,7 @@
 
 /* Begin PBXFileReference section */
 		0BFCB4FD6BC17AB232B26E72 /* Pods_UnitTests.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_UnitTests.framework; sourceTree = BUILT_PRODUCTS_DIR; };
+		1104A8CE2B580AC500B6715F /* SwiftUITextEntry.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SwiftUITextEntry.swift; sourceTree = "<group>"; };
 		1635CE4D251EAC6700907101 /* SnapshotTestingTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SnapshotTestingTests.swift; sourceTree = "<group>"; };
 		358D84DCD315110A89BD052E /* Pods-UnitTests.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-UnitTests.debug.xcconfig"; path = "Pods/Target Support Files/Pods-UnitTests/Pods-UnitTests.debug.xcconfig"; sourceTree = "<group>"; };
 		3A3192D7B9B16BD10FB517A2 /* Pods_SnapshotTests.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_SnapshotTests.framework; sourceTree = BUILT_PRODUCTS_DIR; };
@@ -179,6 +181,7 @@
 			children = (
 				83A295832AC22D9D00DFBE4F /* UserInputLabelsViewController.swift */,
 				3D4674672116A3F100278B57 /* ViewAccessibilityPropertiesViewController.swift */,
+				1104A8CE2B580AC500B6715F /* SwiftUITextEntry.swift */,
 				3F8E5DB82535B25000276B32 /* SwiftUIView.swift */,
 				3FEF854E253846420072611F /* SwiftUIViewWithScrollView.swift */,
 				3D39BFAB223314C1009C3EF4 /* TabBarViewController.swift */,
@@ -627,6 +630,7 @@
 				3DBAC28F2242E7C700EF4D0A /* ListContainerViewController.swift in Sources */,
 				3DBEAA5B2222953E00FAE61D /* SwitchControlViewController.swift in Sources */,
 				3DBAC2912242F9B200EF4D0A /* LandmarkContainerViewController.swift in Sources */,
+				1104A8CF2B580AC500B6715F /* SwiftUITextEntry.swift in Sources */,
 				3D39BFAC223314C1009C3EF4 /* TabBarViewController.swift in Sources */,
 				3D04B6DB21155D92006218A4 /* ButtonAccessibilityTraitsViewController.swift in Sources */,
 			);

Example/AccessibilitySnapshot/SwiftUITextEntry.swift

@@ -0,0 +1,40 @@
+//
+//  Copyright 2024 Square Inc.
+//
+//  Licensed under the Apache License, Version 2.0 (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+//
+//  http://www.apache.org/licenses/LICENSE-2.0
+//
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an "AS IS" BASIS,
+//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//  See the License for the specific language governing permissions and
+//  limitations under the License.
+//
+
+#if swift(>=5.1) && canImport(SwiftUI)
+
+import SwiftUI
+
+struct SwiftUITextEntry: View {
+    var body: some View {
+        VStack {
+            TextField("SwiftUI Text Field", text: .constant(""))
+            TextField("SwiftUI Text Field", text: .constant("Value in Text Field"))
+            if #available(iOS 14.0, *) {
+                TextEditor(text: .constant(""))
+            }
+        }
+    }
+}
+
+struct SwiftUITextEntry_Previews: PreviewProvider {
+    static var previews: some View {
+        SwiftUITextEntry()
+            .previewLayout(.sizeThatFits)
+    }
+}
+
+#endif

Example/SnapshotTests/SnapshotTestingTests.swift

@@ -138,6 +138,17 @@ final class SnapshotTestingTests: XCTestCase {
         assertSnapshot(matching: viewController, as: .imageWithSmartInvert, named: nameForDevice())
     }
 
+    func testTextEntry() {
+        let view = SwiftUITextEntry()
+            .frame(width: 400, height: 400)
+
+        assertSnapshot(
+            matching: view,
+            as: .accessibilityImage,
+            named: nameForDevice()
+        )
+    }
+
     // MARK: - Private Methods
 
     private func nameForDevice(baseName: String? = nil) -> String {

Example/SnapshotTests/__Snapshots__/SnapshotTestingTests/testTextEntry.393x852-16-4-3x.png

@@ -132,6 +132,20 @@ extension NSObject {
             traitSpecifiers.append(strings.tabTraitName)
         }
 
+        if accessibilityTraits.contains(.textEntry) {
+            if accessibilityTraits.contains(.scrollable) {
+                // This is being a UITextView/TextEditor
+                if let accessibilityValue = accessibilityValue, !accessibilityValue.isEmpty {
+                    // No-op. iOS does not read the trait name when there's text.
+                } else {
+                    traitSpecifiers.append(strings.textEntryTraitName)
+                }
+            } else {
+                // This is a UITextField/TextField
+                traitSpecifiers.append(strings.textEntryTraitName)
+            }
+        }
+
         if accessibilityTraits.contains(.header) {
             traitSpecifiers.append(strings.headerTraitName)
         }
@@ -229,6 +243,20 @@ extension NSObject {
             }
         }
 
+        if accessibilityTraits.contains(.textEntry) && !accessibilityTraits.contains(.notEnabled) {
+            if accessibilityTraits.contains(.scrollable) {
+                // This is a UITextView/TextEditor
+                if let accessibilityValue = accessibilityValue, !accessibilityValue.isEmpty {
+                    // No-op. iOS does not read the hint when there's text.
+                } else {
+                    hintDescription = strings.textEntryTraitHint
+                }
+            } else {
+                // This is a UITextField/TextField
+                hintDescription = strings.textEntryTraitHint
+            }
+        }
+
         let hasHintOnly = (accessibilityHint?.nonEmpty() != nil) && (accessibilityLabel?.nonEmpty() == nil) && (accessibilityValue?.nonEmpty() == nil)
         let hidesAdjustableHint = accessibilityTraits.contains(.notEnabled) || accessibilityTraits.contains(.switchButton) || hasHintOnly
         if accessibilityTraits.contains(.adjustable) && !hidesAdjustableHint {
@@ -338,6 +366,10 @@ extension NSObject {
 
         let landmarkEndContext: String
 
+        let textEntryTraitName: String
+
+        let textEntryTraitHint: String
+
         // MARK: - Life Cycle
 
         init(locale: String?) {
@@ -479,6 +511,16 @@ extension NSObject {
                 comment: "Description of the last element in a landmark container",
                 locale: locale
             )
+            self.textEntryTraitName = "Text Field.".localized(
+                key: "trait.text_field.description",
+                comment: "Description for the 'text entry' accessibility trait",
+                locale: locale
+            )
+            self.textEntryTraitHint = "Double tap to edit.".localized(
+                key: "trait.text_field.hint",
+                comment: "Hint describing how to use elements with the 'text entry' accessibility trait",
+                locale: locale
+            )
         }
 
     }
@@ -512,6 +554,11 @@ extension UIAccessibilityTraits {
 
     static let switchButton = UIAccessibilityTraits(rawValue: 0x0020000000000000)
 
+    static let isEditing = UIAccessibilityTraits(rawValue: 0x0000000000200000)
+
+    static let textEntry = UIAccessibilityTraits(rawValue: 0x0000000000040000)
+
+    static let scrollable = UIAccessibilityTraits(rawValue: 0x0000800000000000)
 }
 
 // MARK: -