[DON-715] Whole month in single date selection

Backpack-SwiftUI/Calendar/Classes/AccessibilityConfigurations/SingleAccessibilityConfigurations.swift

@@ -19,10 +19,40 @@
 /// Create a single-selection configuration with given accessibility strings.
 /// - Parameters:
 ///   - selectionHint: The hint provided to assistive technologies informing a user how to select a date.
+///   - wholeMonth: The optional whole month selection configuration for assistive technologies.
 public struct SingleAccessibilityConfigurations {
     let selectionHint: String
+    let wholeMonth: WholeMonthAccessibilityConfigurations?
 
-    public init(selectionHint: String) {
+    public init(
+        selectionHint: String,
+        wholeMonth: WholeMonthAccessibilityConfigurations? = nil
+    ) {
         self.selectionHint = selectionHint
+        self.wholeMonth = wholeMonth
+    }
+}
+
+/// Create a whole-month configuration with given accessibility strings for single selection.
+/// - Parameters:
+///   - startSelectionState: The label provided to assistive technologies informing a user that a date is selected
+///     as the first date in the range.
+///   - endSelectionState: The label provided to assistive technologies informing a user that a date is selected
+///     as the second date in the range.
+///   - betweenSelectionState: The label provided to assistive technologies informing a user that a date lies
+///     between the first and second selected dates.
+public struct WholeMonthAccessibilityConfigurations {
+    let startSelectionState: String
+    let endSelectionState: String
+    let betweenSelectionState: String
+
+    public init(
+        startSelectionState: String,
+        endSelectionState: String,
+        betweenSelectionState: String
+    ) {
+        self.startSelectionState = startSelectionState
+        self.endSelectionState = endSelectionState
+        self.betweenSelectionState = betweenSelectionState
     }
 }

Backpack-SwiftUI/Calendar/Classes/CalendarSelectionType.swift

@@ -28,7 +28,7 @@ public enum CalendarSelectionType {
 
     /// A single selection, where the user can select a single date.
     case single(
-        selected: Binding<Date?>,
+        selected: Binding<CalendarSingleSelectionState?>,
         accessibilityConfigurations: SingleAccessibilityConfigurations
     )
 }

Backpack-SwiftUI/Calendar/Classes/CalendarSignleSelectionState.swift

@@ -0,0 +1,28 @@
+/*
+ * Backpack - Skyscanner's Design System
+ *
+ * Copyright 2018 Skyscanner Ltd
+ *
+ * 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.
+ */
+
+import Foundation
+
+/// The `CalendarSingleSelectionState` enum represents the different states of a single selection.
+public enum CalendarSingleSelectionState {
+    /// The state, with single date selection
+    case single(Date?)
+
+    /// The state the user has selected the whole month.
+    case wholeMonth(ClosedRange<Date>)
+}

Backpack-SwiftUI/Calendar/Classes/Single/SingleCalendarContainer.swift

@@ -19,7 +19,7 @@
 import SwiftUI
 
 struct SingleCalendarContainer<MonthHeader: View, DayAccessoryView: View>: View {
-    @Binding var selection: Date?
+    @Binding var selection: CalendarSingleSelectionState?
     let calendar: Calendar
     let validRange: ClosedRange<Date>
     let accessibilityProvider: SingleDayAccessibilityProvider
@@ -30,20 +30,36 @@ struct SingleCalendarContainer<MonthHeader: View, DayAccessoryView: View>: View
     @ViewBuilder
     private func makeDayCell(_ dayDate: Date) -> some View {
         CalendarSelectableCell {
-            if selection == dayDate {
-                SingleSelectedCell(calendar: calendar, date: dayDate)
-            } else {
+            switch selection {
+            case .single(let date):
+                if date == dayDate {
+                    SingleSelectedCell(calendar: calendar, date: dayDate)
+                } else {
+                    DefaultCalendarDayCell(calendar: calendar, date: dayDate)
+                }
+            case .wholeMonth(let closedRange):
+                if closedRange.contains(dayDate) {
+                    RangeSelectionCalendarDayCell(
+                        date: dayDate,
+                        selection: closedRange,
+                        calendar: calendar,
+                        highlightRangeEnds: false
+                    )
+                } else {
+                    DefaultCalendarDayCell(calendar: calendar, date: dayDate)
+                }
+            case .none:
                 DefaultCalendarDayCell(calendar: calendar, date: dayDate)
             }
         } onSelection: {
-            selection = dayDate
+            selection = .single(dayDate)
         }
         .accessibilityAddTraits(.isButton)
-        .accessibilityAddTraits(selection == dayDate ? .isSelected : [])
-        .accessibilityLabel(accessibilityProvider.accessibilityLabel(for: dayDate))
+        .accessibilityAddTraits(selection?.isSelected(dayDate) == true ? .isSelected : [])
+        .accessibilityLabel(accessibilityProvider.accessibilityLabel(for: dayDate, selection: selection))
         .accessibilityHint(accessibilityProvider.accessibilityHint(for: dayDate, selection: selection))
     }
-    
+
     var body: some View {
         CalendarContainer(
             calendar: calendar,
@@ -77,11 +93,11 @@ struct SingleCalendarContainer_Previews: PreviewProvider {
         let end = calendar.date(from: .init(year: 2025, month: 12, day: 25))!
 
         SingleCalendarContainer(
-            selection: .constant(calendar.date(from: .init(year: 2023, month: 11, day: 10))!),
+            selection: .constant(.single(calendar.date(from: .init(year: 2023, month: 11, day: 10))!)),
             calendar: calendar,
             validRange: start...end,
             accessibilityProvider: SingleDayAccessibilityProvider(
-                accessibilityConfigurations: .init(selectionHint: ""),
+                accessibilityConfigurations: .init(selectionHint: "", wholeMonth: nil),
                 dateFormatter: Self.formatter
             ),
             monthScroll: nil,

Backpack-SwiftUI/Calendar/Classes/Single/SingleDayAccessibilityProvider.swift

@@ -20,14 +20,42 @@ struct SingleDayAccessibilityProvider {
     let accessibilityConfigurations: SingleAccessibilityConfigurations
     let dateFormatter: DateFormatter
 
-    func accessibilityLabel(for dayDate: Date) -> String {
-        dateFormatter.string(from: dayDate)
+    func accessibilityLabel(for dayDate: Date, selection: CalendarSingleSelectionState?) -> String {
+        let baseLabel = dateFormatter.string(from: dayDate)
+
+        if case .wholeMonth(let range) = selection {
+            var state: String?
+            if range.contains(dayDate), let config = accessibilityConfigurations.wholeMonth {
+                if dayDate == range.lowerBound {
+                    state = config.startSelectionState
+                } else if dayDate == range.upperBound {
+                    state = config.endSelectionState
+                } else {
+                    state = config.betweenSelectionState
+                }
+            }
+            guard let state else { return baseLabel }
+            return "\(baseLabel), \(state)"
+        } else {
+            return baseLabel
+        }
     }
-    
-    func accessibilityHint(for dayDate: Date, selection: Date?) -> String {
-        if dayDate == selection {
+
+    func accessibilityHint(for dayDate: Date, selection: CalendarSingleSelectionState?) -> String {
+        if selection?.isSelected(dayDate) == true {
             return ""
         }
         return accessibilityConfigurations.selectionHint
     }
 }
+
+extension CalendarSingleSelectionState {
+    func isSelected(_ date: Date) -> Bool {
+        switch self {
+        case .single(let selectedDate):
+            return selectedDate == date
+        case .wholeMonth(let range):
+            return range.contains(date)
+        }
+    }
+}

Backpack-SwiftUI/Tests/Calendar/BPKCalendarTests.swift

@@ -40,7 +40,7 @@ class BPKCalendarTests: XCTestCase {
         assertSnapshot(
             BPKCalendar(
                 selectionType: .single(
-                    selected: .constant(testDate),
+                    selected: .constant(.single(testDate)),
                     accessibilityConfigurations: SingleAccessibilityConfigurations(
                         selectionHint: ""
                     )

Example/Backpack.xcodeproj/project.pbxproj

@@ -84,7 +84,7 @@
 		53C6622929EA0DAB00BF1A62 /* AttributedTextExampleView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 53C6620F29EA0DAB00BF1A62 /* AttributedTextExampleView.swift */; };
 		53C7F0B92A4C615D003A8740 /* ChipGroupSingleSelectRailExampleView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 53C7F0B52A4C615D003A8740 /* ChipGroupSingleSelectRailExampleView.swift */; };
 		53C7F0BA2A4C615D003A8740 /* ChipGroupSingleSelectWrapExampleView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 53C7F0B62A4C615D003A8740 /* ChipGroupSingleSelectWrapExampleView.swift */; };
-		53D4614E29E574EB0061C222 /* BuildFile in Sources */ = {isa = PBXBuildFile; };
+		53D4614E29E574EB0061C222 /* (null) in Sources */ = {isa = PBXBuildFile; };
 		53D6396F2A7D46ED007EF376 /* MapMarkerExampleView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 53D6396E2A7D46ED007EF376 /* MapMarkerExampleView.swift */; };
 		53D7FBB527F715AF00DEE588 /* UIWindowFactory.swift in Sources */ = {isa = PBXBuildFile; fileRef = 53D7FBB427F715AF00DEE588 /* UIWindowFactory.swift */; };
 		53E075A527FC780C0033147C /* NavBarGroups.swift in Sources */ = {isa = PBXBuildFile; fileRef = 53E075A427FC780C0033147C /* NavBarGroups.swift */; };
@@ -1941,7 +1941,7 @@
 				5390DB612909940700F0F790 /* ColorTokensViewController.swift in Sources */,
 				794E1FF8280CF63100B965FF /* RadiusTokensView.swift in Sources */,
 				53B6DB6A27FC73A90042B7C0 /* LabelGroups.swift in Sources */,
-				53D4614E29E574EB0061C222 /* BuildFile in Sources */,
+				53D4614E29E574EB0061C222 /* (null) in Sources */,
 				53C6621329EA0DAB00BF1A62 /* SpinnerExampleView.swift in Sources */,
 				53BAC3F12A71415800236CC9 /* SectionHeaderGroups.swift in Sources */,
 				53C6622429EA0DAB00BF1A62 /* ButtonsPlaygroundView.swift in Sources */,

Example/Backpack/SwiftUI/Components/Calendar/CalendarExampleSingleView.swift

@@ -21,7 +21,7 @@ import SwiftUI
 import Backpack_SwiftUI
 
 struct CalendarExampleSingleView: View {
-    @State var selectedDate: Date?
+    @State var selection: CalendarSingleSelectionState?
     private var monthScroll: MonthScroll?
 
     let validRange: ClosedRange<Date>
@@ -49,28 +49,39 @@ struct CalendarExampleSingleView: View {
             self.monthScroll = .init(monthToScroll: date, animated: true)
         }
 
-        _selectedDate = State(initialValue: date)
+        _selection = State(initialValue: .single(date))
     }
 
     var body: some View {
         VStack {
             HStack {
                 BPKText("Selected date:", style: .caption)
-                if let selectedDate {
-                    BPKText("\(formatter.string(from: selectedDate))", style: .caption)
+                if case .single(let date) = selection, let date {
+                    BPKText("\(formatter.string(from: date))", style: .caption)
+                } else if case .wholeMonth(let month) = selection {
+                    BPKText("\(formatter.string(from: month.lowerBound))", style: .caption)
                 }
             }
             BPKCalendar(
                 selectionType: .single(
-                    selected: $selectedDate,
+                    selected: $selection,
                     accessibilityConfigurations: SingleAccessibilityConfigurations(
-                        selectionHint: "Double tap to select date"
+                        selectionHint: "Double tap to select date",
+                        wholeMonth: nil
                     )
                 ),
                 calendar: calendar,
                 validRange: validRange,
                 initialMonthScroll: monthScroll
             )
+            .monthAccessoryAction { _ in
+                return CalendarMonthAccessoryAction(
+                    title: "Select whole month",
+                    action: .wholeMonthSelection({ monthRange in
+                        selection = .wholeMonth(monthRange)
+                    })
+                )
+            }
         }
     }
 }