Make BPKCalendar accessibilty non mandatory

Skyscanner · Jan 3, 2025 · 4aac63d · 4aac63d
1 parent 187d7e8
commit 4aac63d
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 46 deletions.
diff --git a/Backpack-SwiftUI/Calendar/Classes/BPKCalendar.swift b/Backpack-SwiftUI/Calendar/Classes/BPKCalendar.swift
@@ -30,6 +30,7 @@ import SwiftUI
 ///   - validRange: The range of dates that the calendar should allow the user to select.
 ///     This is specified as a`ClosedRange<Date>`.
 ///   - initialMonthScroll: The initial scrolling to the month using `MonthScroll`
+///   - calendarAccessibilityConfiguration: The optional configuration to add accessibility strings to the calendar
 ///
 /// The `BPKCalendar` view also allows you to specify an accessory action. This is a closure that takes a string and
 ///     a date, and is called when the user interacts with an accessory in the calendar.
@@ -50,7 +51,7 @@ public struct BPKCalendar<DayAccessoryView: View>: View {
         calendar: Calendar,
         validRange: ClosedRange<Date>,
         initialMonthScroll: MonthScroll? = nil,
-        calendarAccessibilityConfiguration: CalendarAccessibilityConfiguration,
+        calendarAccessibilityConfiguration: CalendarAccessibilityConfiguration = .init(),
         dayAccessoryView: @escaping (Date) -> DayAccessoryView = { _ in EmptyView() }
     ) {
         self.dayAccessoryView = dayAccessoryView

diff --git a/Backpack-SwiftUI/Calendar/Classes/CalendarDayCells/CalendarSelectableCell.swift b/Backpack-SwiftUI/Calendar/Classes/CalendarDayCells/CalendarSelectableCell.swift
@@ -72,21 +72,23 @@ struct CalendarSelectableCell: View {
 
     private var defaultCell: some View {
         DefaultCalendarDayCell(calendar: calendar, date: dayDate)
-            .accessibilityLabel(Text(
-                accessibilityProvider.rangeSelection.accessibilityLabel(for: dayDate)
-            ))
+            .if(accessibilityProvider.rangeSelection != nil) { cell in
+                cell.accessibilityLabel(Text(
+                    accessibilityProvider.rangeSelection?.accessibilityLabel(for: dayDate) ?? ""
+                ))
+            }
     }
 
     private func singleCell(date: Date) -> some View {
         SingleSelectedCell(calendar: calendar, date: dayDate)
-            .accessibilityLabel(
-                Text(
-                    accessibilityProvider.rangeSelection.accessibilityLabel(
+            .if(accessibilityProvider.rangeSelection != nil) { cell in
+                cell.accessibilityLabel(Text(
+                    accessibilityProvider.rangeSelection?.accessibilityLabel(
                         for: dayDate,
                         intermediateSelectionDate: date
-                    )
-                )
-            )
+                    ) ?? ""
+                ))
+            }
     }
 
     private func rangeCell(closedRange: ClosedRange<Date>, highlightRangeEnds: Bool) -> some View {
@@ -96,13 +98,15 @@ struct CalendarSelectableCell: View {
             calendar: calendar,
             highlightRangeEnds: highlightRangeEnds
         )
-        .accessibilityLabel(Text(
-            accessibilityProvider.rangeSelection.accessibilityLabel(
-                for: dayDate,
-                selection: closedRange
-            )
-        ))
         .accessibility(addTraits: .isSelected)
+        .if(accessibilityProvider.rangeSelection != nil) { cell in
+            cell.accessibilityLabel(Text(
+                accessibilityProvider.rangeSelection?.accessibilityLabel(
+                    for: dayDate,
+                    selection: closedRange
+                ) ?? ""
+            ))
+        }
     }
 
     private func wholeMonthRangeCell(range: ClosedRange<Date>) -> some View {
@@ -112,13 +116,15 @@ struct CalendarSelectableCell: View {
             calendar: calendar,
             highlightRangeEnds: false
         )
-        .accessibilityLabel(Text(
-            accessibilityProvider.rangeSelection.accessibilityLabel(
-                for: dayDate,
-                selection: range
-            )
-        ))
         .accessibility(addTraits: .isSelected)
+        .if(accessibilityProvider.rangeSelection != nil) { cell in
+            cell.accessibilityLabel(Text(
+                accessibilityProvider.rangeSelection?.accessibilityLabel(
+                    for: dayDate,
+                    selection: range
+                ) ?? ""
+            ))
+        }
     }
 
     private func initialSelection(_ initialDateSelection: Date, matchesDate date: Date) -> Bool {

diff --git a/Backpack-SwiftUI/Calendar/Classes/Core/CalendarTypeContainerFactory.swift b/Backpack-SwiftUI/Calendar/Classes/Core/CalendarTypeContainerFactory.swift
@@ -19,9 +19,12 @@
 import SwiftUI
 
 public struct CalendarAccessibilityConfiguration {
-    public let singleSelection: SingleDayAccessibilityProvider
-    public let rangeSelection: RangeDayAccessibilityProvider
-    public init(singleSelection: SingleDayAccessibilityProvider, rangeSelection: RangeDayAccessibilityProvider) {
+    public let singleSelection: SingleDayAccessibilityProvider?
+    public let rangeSelection: RangeDayAccessibilityProvider?
+    public init(
+        singleSelection: SingleDayAccessibilityProvider? = nil,
+        rangeSelection: RangeDayAccessibilityProvider? = nil
+    ) {
         self.singleSelection = singleSelection
         self.rangeSelection = rangeSelection
     }
@@ -124,7 +127,7 @@ struct CalendarTypeContainerFactory<MonthHeader: View, DayAccessoryView: View>:
                     selection.wrappedValue = .intermediate(dayDate)
                     UIAccessibility.post(
                         notification: .announcement,
-                        argument: calendarAccessibilityConfiguration.rangeSelection
+                        argument: calendarAccessibilityConfiguration.rangeSelection?
                             .accessibilityInstructionAfterSelectingDate()
                     )
                 } else {
@@ -134,7 +137,7 @@ struct CalendarTypeContainerFactory<MonthHeader: View, DayAccessoryView: View>:
                 selection.wrappedValue = .intermediate(dayDate)
                 UIAccessibility.post(
                     notification: .announcement,
-                    argument: calendarAccessibilityConfiguration.rangeSelection
+                    argument: calendarAccessibilityConfiguration.rangeSelection?
                         .accessibilityInstructionAfterSelectingDate()
                 )
             }

diff --git a/Example/Backpack/SwiftUI/Components/Calendar/CalendarExampleWholeMonthView.swift b/Example/Backpack/SwiftUI/Components/Calendar/CalendarExampleWholeMonthView.swift
@@ -82,25 +82,7 @@ struct CalendarExampleWholeMonthView: View {
                 accessibilityConfigurations: accessibilityConfigurations
             ),
             calendar: calendar,
-            validRange: validRange,
-            calendarAccessibilityConfiguration: CalendarAccessibilityConfiguration(
-                singleSelection: .init(
-                    accessibilityConfigurations: .init(selectionHint: "hint"),
-                    dateFormatter: DateFormatter()
-                ),
-                rangeSelection: .init(
-                    accessibilityConfigurations: .init(
-                        startSelectionHint: "startSelectionHint",
-                        endSelectionHint: "endSelectionHint",
-                        startSelectionState: "startSelectionState",
-                        endSelectionState: "endSelectionState",
-                        betweenSelectionState: "betweenSelectionState",
-                        startAndEndSelectionState: "startAndEndSelectionState",
-                        returnDatePrompt: "returnDatePrompt"
-                    ),
-                    dateFormatter: DateFormatter()
-                )
-            )
+            validRange: validRange
         )
         .monthAccessoryAction { _ in
             return CalendarMonthAccessoryAction(