Easy accessibility configuration for views was added

AccessibilitySetting
Swift-CoreUI · Dec 16, 2022 · 2d9d1ef · 2d9d1ef
1 parent f0d3266
commit 2d9d1ef
Show file tree

Hide file tree

Showing 9 changed files with 195 additions and 15 deletions.
diff --git a/Sources/CoreUI/UI/UI+Accessibility.swift b/Sources/CoreUI/UI/UI+Accessibility.swift
@@ -0,0 +1,44 @@
+import UIKit
+
+public extension UI {
+    enum AccessibilitySetting {
+        case isElement(Bool)
+        case identifier(String)
+        case label(String)
+        case hint(String)
+        case value(String)
+        case traits(UIAccessibilityTraits)
+        case containerType(UIAccessibilityContainerType)
+        case elements([Any])
+        case elementsHidden(Bool)
+        case shouldGroupChildren(Bool)
+    }
+}
+
+internal extension UI.AccessibilitySetting {
+    func apply(to view: UIView) {
+        switch self {
+        case .isElement(let isElement):
+            view.isAccessibilityElement = isElement
+        case .identifier(let identifier):
+            view.accessibilityIdentifier = identifier
+        case .label(let label):
+            view.accessibilityLabel = label
+        case .hint(let hint):
+            view.accessibilityHint = hint
+        case .value(let value):
+            view.accessibilityValue = value
+        case .traits(let traits):
+            view.accessibilityTraits = traits
+        case .containerType(let type):
+            view.accessibilityContainerType = type
+        case .elementsHidden(let isHidden):
+            view.accessibilityElementsHidden = isHidden
+        case .elements(let elements):
+            view.accessibilityElements = elements
+        case .shouldGroupChildren(let shouldGroup):
+            view.shouldGroupAccessibilityChildren = shouldGroup
+        }
+    }
+}
+
diff --git a/Sources/CoreUI/UI/UI+Button.swift b/Sources/CoreUI/UI/UI+Button.swift
@@ -15,6 +15,7 @@ public extension UI {
                        isSelected: Bool = false,
                        width: CGFloat? = nil,
                        height: CGFloat? = nil,
+                       accessibility additionalAccessibilitySettings: [AccessibilitySetting] = [],
                        apply: ((UIButton) -> Void)? = nil
     ) -> UIButton {
         let button = View(backgroundColor: backgroundColor, width: width, height: height) as UIButton
@@ -26,6 +27,7 @@ public extension UI {
 
         if let title = title {
             button.setTitle(title, for: .normal)
+            button.accessibility(.label(title))
         }
 
         if let image = image {
@@ -45,7 +47,10 @@ public extension UI {
         }
 
         button.isSelected = isSelected
-
+
+        button.accessibility(.isElement(true), .shouldGroupChildren(true), .traits(.button))
+        button.accessibility(additionalAccessibilitySettings)
+
         apply?(button)
 
         return button
@@ -59,12 +64,13 @@ public extension UI {
                        isSelected: Bool = false,
                        width: CGFloat? = nil,
                        height: CGFloat? = nil,
+                       accessibility additionalAccessibilitySettings: [AccessibilitySetting] = [],
                        apply: ((UIButton) -> Void)? = nil
     ) -> UIButton {
         let button = View(backgroundColor: backgroundColor, width: width, height: height) as UIButton
 
         button.setAttributedTitle(attributedTitle, for: .normal)
-        
+
         if let image = image {
             button.setImage(image, for: .normal)
         }
@@ -79,16 +85,14 @@ public extension UI {
 
         button.isSelected = isSelected
 
-        apply?(button)
-
-        button.isAccessibilityElement = true
-        button.shouldGroupAccessibilityChildren = true
-        button.accessibilityTraits = .button
-        button.accessibilityLabel = attributedTitle.string
-
         button.titleLabel?.adjustsFontForContentSizeCategory = true
         button.adjustsImageSizeForAccessibilityContentSizeCategory = true
-
+
+        button.accessibility(.isElement(true), .shouldGroupChildren(true), .traits(.button), .label(attributedTitle.string))
+        button.accessibility(additionalAccessibilitySettings)
+
+        apply?(button)
+
         return button
     }
 

diff --git a/Sources/CoreUI/UI/UI+ImageView.swift b/Sources/CoreUI/UI/UI+ImageView.swift
@@ -13,6 +13,7 @@ public extension UI {
                           cornerRadius: CGFloat? = nil,
                           contentMode: UIView.ContentMode = .scaleAspectFill,
                           clipsToBounds: Bool = true,
+                          accessibility accessibilitySettings: [AccessibilitySetting] = [],
                           apply: ((UIImageView) -> Void)? = nil
     ) -> UIImageView {
         let imageView = UIImageView()
@@ -53,6 +54,8 @@ public extension UI {
             imageView.layer.cornerRadius = cornerRadius
         }
 
+        imageView.accessibility(accessibilitySettings)
+
         var constraints: [NSLayoutConstraint] = []
 
         if let width = width {

diff --git a/Sources/CoreUI/UI/UI+Label.swift b/Sources/CoreUI/UI/UI+Label.swift
@@ -11,6 +11,7 @@ public extension UI {
                       lineBreakMode: NSLineBreakMode = .byTruncatingTail,
                       minWidth: CGFloat? = nil,
                       minHeight: CGFloat? = nil,
+                      accessibility accessibilitySettings: [AccessibilitySetting] = [],
                       apply: ((UILabel) -> Void)? = nil
     ) -> UILabel {
         let label = UILabel()
@@ -26,6 +27,8 @@ public extension UI {
             label.text = text
         }
 
+        label.accessibility(accessibilitySettings)
+
         var constraints: [NSLayoutConstraint] = []
 
         if let width = minWidth {
@@ -50,6 +53,7 @@ public extension UI {
                       lineBreakMode: NSLineBreakMode = .byTruncatingTail,
                       minWidth: CGFloat? = nil,
                       minHeight: CGFloat? = nil,
+                      accessibility accessibilitySettings: [AccessibilitySetting] = [],
                       apply: ((UILabel) -> Void)? = nil
     ) -> UILabel {
         let label = UILabel()
@@ -60,6 +64,8 @@ public extension UI {
         label.adjustsFontForContentSizeCategory = true
 
         label.attributedText = attributedText
+
+        label.accessibility(accessibilitySettings)
 
         var constraints: [NSLayoutConstraint] = []
 

diff --git a/Sources/CoreUI/UI/UI+Stack.swift b/Sources/CoreUI/UI/UI+Stack.swift
@@ -3,13 +3,14 @@ import UIKit
 // swiftlint:disable identifier_name type_body_length
 // swiftlint:disable:next type_name
 public extension UI {
-    
+
     private static func Stack(axis: NSLayoutConstraint.Axis,
                               spacing: CGFloat,
                               distribution: UIStackView.Distribution,
                               alignment: UIStackView.Alignment,
                               backgroundColor: UIColor?,
                               isInteractionEnabled: Bool?,
+                              accessibility accessibilitySettings: [AccessibilitySetting],
                               _ subviews: [UIView?] = [],
                               apply: ((UIStackView) -> Void)? = nil
     ) -> UIStackView {
@@ -25,6 +26,8 @@ public extension UI {
             stack.isUserInteractionEnabled = isInteractionEnabled
         }
 
+        stack.accessibility(accessibilitySettings)
+
         if #available(iOS 14.0, *) {
             if let backgroundColor = backgroundColor {
                 stack.backgroundColor = backgroundColor
@@ -42,6 +45,7 @@ public extension UI {
                        alignment: UIStackView.Alignment = .fill,
                        backgroundColor: UIColor? = nil,
                        isInteractionEnabled: Bool? = nil,
+                       accessibility: [AccessibilitySetting] = [],
                        _ subviews: [UIView?] = [],
                        apply: ((UIStackView) -> Void)? = nil
     ) -> UIStackView {
@@ -51,6 +55,7 @@ public extension UI {
               alignment: alignment,
               backgroundColor: backgroundColor,
               isInteractionEnabled: isInteractionEnabled,
+              accessibility: accessibility,
               subviews,
               apply: apply
         )
@@ -62,6 +67,7 @@ public extension UI {
                        alignment: UIStackView.Alignment = .fill,
                        backgroundColor: UIColor? = nil,
                        isInteractionEnabled: Bool? = nil,
+                       accessibility: [AccessibilitySetting] = [],
                        _ subviews: UIView?...,
                        apply: ((UIStackView) -> Void)? = nil
     ) -> UIStackView {
@@ -70,6 +76,7 @@ public extension UI {
                alignment: alignment,
                backgroundColor: backgroundColor,
                isInteractionEnabled: isInteractionEnabled,
+               accessibility: accessibility,
                subviews,
                apply: apply
         )
@@ -81,6 +88,7 @@ public extension UI {
                        alignment: UIStackView.Alignment = .fill,
                        backgroundColor: UIColor? = nil,
                        isInteractionEnabled: Bool? = nil,
+                       accessibility: [AccessibilitySetting] = [],
                        _ subviews: [UIView?] = [],
                        apply: ((UIStackView) -> Void)? = nil
     ) -> UIStackView {
@@ -90,6 +98,7 @@ public extension UI {
               alignment: alignment,
               backgroundColor: backgroundColor,
               isInteractionEnabled: isInteractionEnabled,
+              accessibility: accessibility,
               subviews,
               apply: apply
         )
@@ -101,6 +110,7 @@ public extension UI {
                        alignment: UIStackView.Alignment = .fill,
                        backgroundColor: UIColor? = nil,
                        isInteractionEnabled: Bool? = nil,
+                       accessibility: [AccessibilitySetting] = [],
                        _ subviews: UIView?...,
                        apply: ((UIStackView) -> Void)? = nil
     ) -> UIStackView {
@@ -109,6 +119,7 @@ public extension UI {
                alignment: alignment,
                backgroundColor: backgroundColor,
                isInteractionEnabled: isInteractionEnabled,
+               accessibility: accessibility,
                subviews,
                apply: apply
         )

diff --git a/Sources/CoreUI/UI/UI+TextView.swift b/Sources/CoreUI/UI/UI+TextView.swift
@@ -9,6 +9,7 @@ public extension UI {
                          font: UIFont? = nil,
                          textColor: UIColor? = nil,
                          linkTextAttributes: [NSAttributedString.Key: Any]? = nil,
+                         accessibility accessibilitySettings: [AccessibilitySetting] = [],
                          apply: ((UITextView) -> Void)? = nil
     ) -> UITextView {
         let textView = UITextView()
@@ -42,6 +43,8 @@ public extension UI {
         if let textColor = textColor {
             textView.textColor = textColor
         }
+
+        textView.accessibility(accessibilitySettings)
 
         apply?(textView)
 

diff --git a/Sources/CoreUI/UI/UI+View.swift b/Sources/CoreUI/UI/UI+View.swift
@@ -10,6 +10,7 @@ public extension UI {
                                        minWidth: CGFloat? = nil,
                                        minHeight: CGFloat? = nil,
                                        cornerRadius: CGFloat? = nil,
+                                       accessibility accessibilitySettings: [AccessibilitySetting] = [],
                                        _ subviews: [UIView?],
                                        apply: ((ViewType) -> Void)? = nil
     ) -> ViewType {
@@ -29,6 +30,8 @@ public extension UI {
             view.addSubview(subview)
         }
 
+        view.accessibility(accessibilitySettings)
+
         var constraints: [NSLayoutConstraint] = []
 
         if let width = width {
@@ -61,6 +64,7 @@ public extension UI {
                                        minWidth: CGFloat? = nil,
                                        minHeight: CGFloat? = nil,
                                        cornerRadius: CGFloat? = nil,
+                                       accessibility accessibilitySettings: [AccessibilitySetting] = [],
                                        _ subviews: UIView?...,
                                        apply: ((ViewType) -> Void)? = nil
     ) -> ViewType {
@@ -70,6 +74,7 @@ public extension UI {
              minWidth: minWidth,
              minHeight: minHeight,
              cornerRadius: cornerRadius,
+             accessibility: accessibilitySettings,
              subviews,
              apply: apply)
     }
@@ -82,23 +87,38 @@ public extension UI {
                                        height: CGFloat? = nil,
                                        minHeight: CGFloat? = nil,
                                        cornerRadius: CGFloat? = nil,
+                                       accessibility accessibilitySettings: [AccessibilitySetting] = [],
                                        _ subview: UIView,
                                        _ anchors: LayoutAnchor...,
                                        apply: ((ViewType) -> Void)? = nil
     ) -> ViewType {
-        View(backgroundColor: backgroundColor, width: width, height: height, minHeight: minHeight, cornerRadius: cornerRadius, subview, anchors, apply: apply)
+        View(backgroundColor: backgroundColor,
+             width: width,
+             height: height,
+             minHeight: minHeight,
+             cornerRadius: cornerRadius,
+             accessibility: accessibilitySettings,
+             subview,
+             anchors,
+             apply: apply)
     }
 
     static func View<ViewType: UIView>(backgroundColor: UIColor? = nil,
                                        width: CGFloat? = nil,
                                        height: CGFloat? = nil,
                                        minHeight: CGFloat? = nil,
                                        cornerRadius: CGFloat? = nil,
+                                       accessibility accessibilitySettings: [AccessibilitySetting] = [],
                                        _ subview: UIView,
                                        _ anchors: [LayoutAnchor],
                                        apply: ((ViewType) -> Void)? = nil
     ) -> ViewType {
-        let view = View(backgroundColor: backgroundColor, width: width, height: height, minHeight: minHeight, cornerRadius: cornerRadius) as ViewType
+        let view = View(backgroundColor: backgroundColor,
+                        width: width,
+                        height: height,
+                        minHeight: minHeight,
+                        cornerRadius: cornerRadius,
+                        accessibility: accessibilitySettings) as ViewType
         view.addSubview(subview, anchors)
         apply?(view)
         return view
@@ -115,19 +135,31 @@ public extension UI {
     static func Control(backgroundColor: UIColor? = nil,
                         width: CGFloat? = nil,
                         height: CGFloat? = nil,
+                        accessibility accessibilitySettings: [AccessibilitySetting] = [],
                         _ subviews: [UIView],
                         apply: ((UIControl) -> Void)? = nil
     ) -> UIControl {
-        View(backgroundColor: backgroundColor, width: width, height: height, subviews, apply: apply)
+        View(backgroundColor: backgroundColor,
+             width: width,
+             height: height,
+             accessibility: accessibilitySettings,
+             subviews,
+             apply: apply)
     }
 
     static func Control(backgroundColor: UIColor? = nil,
                         width: CGFloat? = nil,
                         height: CGFloat? = nil,
+                        accessibility accessibilitySettings: [AccessibilitySetting] = [],
                         _ subviews: UIView...,
                         apply: ((UIControl) -> Void)? = nil
     ) -> UIControl {
-        View(backgroundColor: backgroundColor, width: width, height: height, subviews, apply: apply)
+        View(backgroundColor: backgroundColor,
+             width: width,
+             height: height,
+             accessibility: accessibilitySettings,
+             subviews,
+             apply: apply)
     }
 
 }

diff --git a/Sources/CoreUI/UI/UIView+accessibility.swift b/Sources/CoreUI/UI/UIView+accessibility.swift
@@ -0,0 +1,13 @@
+import UIKit
+
+public extension UIView {
+    func accessibility(_ settings: [UI.AccessibilitySetting]) {
+        for setting in settings {
+            setting.apply(to: self)
+        }
+    }
+
+    func accessibility(_ settings: UI.AccessibilitySetting...) {
+        accessibility(settings)
+    }
+}