DON-1068: Add floating year label configuration to BPKCalendar

Backpack-SwiftUI/Calendar/Classes/BPKCalendar.swift

@@ -40,7 +40,7 @@ public struct BPKCalendar<DayAccessoryView: View>: View {
     private var accessoryAction: ((Date) -> CalendarMonthAccessoryAction?)?
     private var initialMonthScroll: MonthScroll?
     private let monthHeaderDateFormatter: DateFormatter
-
+    private let showFloatYearLabel: Bool
     private let dayAccessoryView: (Date) -> DayAccessoryView
     @State private var currentlyShownMonth: Date
 
@@ -49,6 +49,7 @@ public struct BPKCalendar<DayAccessoryView: View>: View {
         calendar: Calendar,
         validRange: ClosedRange<Date>,
         initialMonthScroll: MonthScroll? = nil,
+        showFloatYearLabel: Bool = true,
         dayAccessoryView: @escaping (Date) -> DayAccessoryView = { _ in EmptyView() }
     ) {
         self.dayAccessoryView = dayAccessoryView
@@ -57,6 +58,7 @@ public struct BPKCalendar<DayAccessoryView: View>: View {
         self.calendar = calendar
         self.selectionType = selectionType
         self.initialMonthScroll = initialMonthScroll
+        self.showFloatYearLabel = showFloatYearLabel
 
         monthHeaderDateFormatter = DateFormatter()
         monthHeaderDateFormatter.timeZone = calendar.timeZone
@@ -90,7 +92,9 @@ public struct BPKCalendar<DayAccessoryView: View>: View {
                         },
                         dayAccessoryView: dayAccessoryView
                     )
-                    yearBadge
+                    if showFloatYearLabel {
+                        yearBadge
+                    }
                 }
             }
         }

Backpack-SwiftUI/Calendar/README.md

@@ -80,3 +80,16 @@ BPKCalendar(
     }
 )
 ```
+
+## Float year label
+
+There is a configurable option to hide/show a floating year label from the calendar view. Default option is to show the year.
+
+```swift
+BPKCalendar(
+    selectionType: .range(selectedRange: $selectedDateRange),
+    calendar: .current,
+    validRange: validStartDate...validEndDate,
+    showFloatYearLabel: false
+)
+```

Backpack-SwiftUI/Tests/Calendar/BPKCalendarTests.swift

@@ -140,4 +140,23 @@ class BPKCalendarTests: XCTestCase {
                 .frame(width: 400)
         )
     }
+
+    func test_singleSelectionCalendarWithNoFloatYearLabel() {
+        let testDate = Calendar.current.date(from: DateComponents(year: 2020, month: 2, day: 5))!
+
+        assertSnapshot(
+            BPKCalendar(
+                selectionType: .single(
+                    selected: .constant(.single(testDate)),
+                    accessibilityConfigurations: SingleAccessibilityConfigurations(
+                        selectionHint: ""
+                    )
+                ),
+                calendar: Calendar.current,
+                validRange: validStart...validEnd,
+                showFloatYearLabel: false
+            )
+            .frame(width: 320, height: 720)
+        )
+    }
 }

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

@@ -28,14 +28,16 @@ struct CalendarExampleRangeView: View {
     let calendar: Calendar
     let formatter: DateFormatter
     let showAccessoryViews: Bool
+    let showFloatYearLabel: Bool
 
-    init(showAccessoryViews: Bool, makeInitialMonthScroll: Bool = false) {
+    init(showAccessoryViews: Bool, showFloatYearLabel: Bool = true, makeInitialMonthScroll: Bool = false) {
         let calendar = Calendar.current
         let start = calendar.date(from: .init(year: 2023, month: 11, day: 6))!
         let end = calendar.date(from: .init(year: 2024, month: 11, day: 28))!
 
         self.validRange = start...end
         self.calendar = calendar
+        self.showFloatYearLabel = showFloatYearLabel
 
         let formatter = DateFormatter()
         formatter.dateStyle = .short
@@ -96,6 +98,7 @@ struct CalendarExampleRangeView: View {
                 ),
                 calendar: calendar,
                 validRange: validRange,
+                showFloatYearLabel: showFloatYearLabel,
                 dayAccessoryView: { _ in
                     BPKIconView(.search, size: .small)
                         .foregroundColor(.accentColor)
@@ -109,7 +112,8 @@ struct CalendarExampleRangeView: View {
                 ),
                 calendar: calendar,
                 validRange: validRange,
-                initialMonthScroll: monthScroll
+                initialMonthScroll: monthScroll,
+                showFloatYearLabel: showFloatYearLabel
             )
         }
     }

Example/Backpack/Utils/FeatureStories/Groups/CalendarGroups.swift

@@ -80,6 +80,10 @@ struct CalendarGroupsProvider {
                 presentableCalendar("Range Selection", view: CalendarExampleRangeView(showAccessoryViews: false)),
                 presentableCalendar("Single Selection", view: CalendarExampleSingleView()),
                 presentableCalendar("With Accessory Views", view: CalendarExampleRangeView(showAccessoryViews: true)),
+                presentableCalendar(
+                    "With No Float Year Labelst",
+                    view: CalendarExampleRangeView(showAccessoryViews: false, showFloatYearLabel: false)
+                ),
                 presentableCalendar("With Whole Month Selection", view: CalendarExampleWholeMonthView()),
                 presentableCalendar(
                     "With Initial Month Scrolling",