[Issue-11] Make dimmer a Close button in VO mode. (#23)

* [CM-1254] Make dimmer a Close button in VO mode.

* [CM-1254] Comment updated

* [CM-1254] Swiftlint line length error fixed.

* [CM-1254] Comments updated.

* Update to latest dependencies

* Rename files

* Test with Xcode 14.3 / iOS 16.4

* Set VO focus to sheet not dimmer

* Run Xcode 14.2 for CI/CD

---------

Co-authored-by: Mark Pospesel <[email protected]>

Author: devkaranCT

.github/workflows/run_linter_and_unit_tests.yml

@@ -20,15 +20,15 @@ jobs:
     - name: Set Xcode version
       run: |
         ls -l /Applications | grep 'Xcode'
-        sudo xcode-select -s /Applications/Xcode_14.0.1.app
+        sudo xcode-select -s /Applications/Xcode_14.2.app
 
     - name: Lint code using SwiftLint
       run: swiftlint --strict --reporter github-actions-logging
 
     - name: Build iOS
       run:  |
-          xcodebuild -scheme YBottomSheet -sdk iphonesimulator16.0 -destination 'platform=iOS Simulator,name=iPhone 14' build-for-testing
+          xcodebuild -scheme YBottomSheet -sdk iphonesimulator16.2 -destination 'platform=iOS Simulator,name=iPhone 14' build-for-testing
           
     - name: Run tests iOS
       run: |
-          xcodebuild -scheme YBottomSheet -sdk iphonesimulator16.0 -destination 'platform=iOS Simulator,name=iPhone 14' test-without-building
+          xcodebuild -scheme YBottomSheet -sdk iphonesimulator16.2 -destination 'platform=iOS Simulator,name=iPhone 14' test-without-building

Package.swift

@@ -17,7 +17,7 @@ let package = Package(
     dependencies: [
         .package(
             url: "https://github.com/yml-org/YCoreUI.git",
-            from: "1.5.0"
+            from: "1.7.0"
         ),
         .package(
             url: "https://github.com/yml-org/YMatterType.git",

Sources/YBottomSheet/BottomSheetController.swift

@@ -12,33 +12,26 @@ import UIKit
 public class BottomSheetController: UIViewController {
     // Holds the sheet content until the view is loaded
     private let content: Content
-    private enum Content {
-        case view(title: String, view: UIView)
-        case controller(_: UIViewController)
-    }
-
     private var shadowSize: CGSize = .zero
     private let minimumTopOffset: CGFloat = 44
     private let minimumContentHeight: CGFloat = 88
     private var topAnchor: NSLayoutConstraint?
     private var indicatorTopAnchor: NSLayoutConstraint?
     private var childHeightAnchor: NSLayoutConstraint?
     private var panGesture: UIPanGestureRecognizer?
-    internal lazy var lastYOffset: CGFloat = {
-        sheetView.frame.origin.y
-    }()
+    internal lazy var lastYOffset: CGFloat = { sheetView.frame.origin.y }()
 
     /// Minimum downward velocity beyond which we interpret a pan gesture as a downward swipe.
     public var dismissThresholdVelocity: CGFloat = 1000
-
-    /// Priorities for various non-required constraints.
-    enum Priorities {
-        static let panGesture = UILayoutPriority(775)
-        static let sheetContentHugging = UILayoutPriority(751)
-        static let sheetCompressionResistanceLow = UILayoutPriority.defaultLow
-        static let sheetCompressionResistanceHigh = UILayoutPriority(800)
-    }
-
+    
+    /// Dimmer tap view
+    let dimmerTapView: UIView = {
+        let view = UIView()
+        view.accessibilityTraits = .button
+        view.accessibilityLabel = BottomSheetController.Strings.closeButton.localized
+        view.accessibilityIdentifier = AccessibilityIdentifiers.dimmerId
+        return view
+    }()
     /// Dimmer view.
     let dimmerView = UIView()
     /// Bottom sheet view.
@@ -133,7 +126,14 @@ public class BottomSheetController: UIViewController {
         super.viewDidLoad()
         build()
     }
-    
+
+    /// :nodoc:
+    public override func viewDidAppear(_ animated: Bool) {
+        super.viewDidAppear(animated)
+        // set initial VO focus to the sheet not the dimmer
+        UIAccessibility.post(notification: .screenChanged, argument: sheetView)
+    }
+
     /// :nodoc:
     public override func viewDidLayoutSubviews() {
         super.viewDidLayoutSubviews()
@@ -204,13 +204,13 @@ private extension BottomSheetController {
     func buildSheet() {
         buildViews()
         buildConstraints()
-        view.layoutIfNeeded()
         updateViewAppearance()
         addGestures()
     }
 
     func buildViews() {
         view.addSubview(dimmerView)
+        view.addSubview(dimmerTapView)
         view.addSubview(sheetView)
         sheetView.addSubview(stackView)
         stackView.addArrangedSubview(indicatorContainer)
@@ -220,8 +220,10 @@ private extension BottomSheetController {
 
     func buildConstraints() {
         dimmerView.constrainEdges()
+        dimmerTapView.constrainEdges(.notBottom)
+        dimmerTapView.constrain(.bottomAnchor, to: sheetView.topAnchor)
+        
         sheetView.constrainEdges(.notTop)
-
         sheetView.constrain(
             .topAnchor,
             to: view.safeAreaLayoutGuide.topAnchor,
@@ -246,6 +248,7 @@ private extension BottomSheetController {
     }
 
     func updateViewAppearance() {
+        dimmerTapView.isAccessibilityElement = appearance.isDismissAllowed
         sheetView.layer.cornerRadius = appearance.layout.cornerRadius
         updateShadow()
         dimmerView.backgroundColor = appearance.dimmerColor
@@ -316,7 +319,7 @@ private extension BottomSheetController {
         swipeGesture.direction = .down
         view.addGestureRecognizer(swipeGesture)
         let tapGesture = UITapGestureRecognizer(target: self, action: #selector(onDimmerTap))
-        dimmerView.addGestureRecognizer(tapGesture)
+        dimmerTapView.addGestureRecognizer(tapGesture)
     }
 
     func onDismiss() {
@@ -344,7 +347,7 @@ private extension BottomSheetController {
     }
 
     @objc
-    private func handlePan(_ gesture: UIPanGestureRecognizer) {
+    func handlePan(_ gesture: UIPanGestureRecognizer) {
         switch gesture.state {
         case .began, .changed:
             let translation = gesture.translation(in: sheetView)
@@ -383,8 +386,7 @@ internal extension BottomSheetController {
         onDimmerTap(sender: UITapGestureRecognizer())
     }
 
-    @objc
-    @discardableResult
+    @objc @discardableResult
     func simulateDragging(_ gesture: UIPanGestureRecognizer) -> Bool {
         guard isResizable else { return false }
         handlePan(gesture)

Sources/YBottomSheet/Enums/BottomSheetController+AccessibilityIdentifiers.swift

@@ -0,0 +1,17 @@
+//
+//  BottomSheetController+AccessibilityIdentifiers.swift
+//  YBottomSheet
+//
+//  Created by Dev Karan on 25/04/23.
+//  Copyright © 2023 Y Media Labs. All rights reserved.
+//
+
+extension BottomSheetController {
+    /// Accessibility Identifiers
+    enum AccessibilityIdentifiers {
+        /// Button ID
+        static let buttonId = "sheet.button.close"
+        /// Dimmer ID
+        static let dimmerId = "sheet.dimmer.close"
+    }
+}

Sources/YBottomSheet/Enums/BottomSheetController+Enums.swift

@@ -0,0 +1,26 @@
+//
+//  BottomSheetController+Enums.swift
+//  YBottomSheet
+//
+//  Created by Dev Karan on 25/04/23.
+//  Copyright © 2023 Y Media Labs. All rights reserved.
+//
+
+import Foundation
+import UIKit
+
+internal extension BottomSheetController {
+    /// Priorities for various non-required constraints.
+    enum Priorities {
+        static let panGesture = UILayoutPriority(775)
+        static let sheetContentHugging = UILayoutPriority(751)
+        static let sheetCompressionResistanceLow = UILayoutPriority.defaultLow
+        static let sheetCompressionResistanceHigh = UILayoutPriority(800)
+    }
+
+    /// Types of content that can populate a bottom sheet
+    enum Content {
+        case view(title: String, view: UIView)
+        case controller(_: UIViewController)
+    }
+}

Sources/YBottomSheet/Enums/YBottomSheet+Strings.swift renamed to Sources/YBottomSheet/Enums/BottomSheetController+Strings.swift

@@ -1,5 +1,5 @@
 //
-//  YBottomSheet+Strings.swift
+//  BottomSheetController+Strings.swift
 //  YBottomSheet
 //
 //  Created by Dev Karan on 15/02/23.

Sources/YBottomSheet/SheetHeaderView/SheetHeaderView.swift

@@ -66,6 +66,7 @@ private extension SheetHeaderView {
         buildConstraints()
         closeButton.addTarget(self, action: #selector(closeButtonAction), for: .touchUpInside)
         closeButton.accessibilityLabel = BottomSheetController.Strings.closeButton.localized
+        closeButton.accessibilityIdentifier = BottomSheetController.AccessibilityIdentifiers.buttonId
     }
 
     func buildViews() {

Tests/YBottomSheetTests/Enums/YBottomSheet+StringsTests.swift renamed to Tests/YBottomSheetTests/Enums/BottomSheetController+StringsTests.swift

@@ -1,5 +1,5 @@
 //
-//  YBottomSheet+StringsTests.swift
+//  BottomSheetController+StringsTests.swift
 //  YBottomSheet
 //
 //  Created by Dev Karan on 15/02/23.
@@ -10,7 +10,7 @@ import XCTest
 import YCoreUI
 @testable import YBottomSheet
 
-final class YBottomSheetStringsTests: XCTestCase {
+final class BottomSheetControllerStringsTests: XCTestCase {
     func testLoad() {
         BottomSheetController.Strings.allCases.forEach {
             // Given a localized string constant