Merge pull request #10 from MFB-Technologies-Inc/feature/segmented-pi…

…cker-animation Feature/segmented picker animation
MFB-Technologies-Inc · Nov 15, 2024 · e4117a6 · e4117a6
2 parents 1b42855 + 24c6288
commit e4117a6
Show file tree

Hide file tree

Showing 10 changed files with 390 additions and 2 deletions.
diff --git a/Example/Example.xcodeproj/project.pbxproj b/Example/Example.xcodeproj/project.pbxproj
@@ -26,6 +26,7 @@
 		49E598B127B230AF00C1F2CF /* ExampleApp.swift in Sources */ = {isa = PBXBuildFile; fileRef = 49E598B027B230AF00C1F2CF /* ExampleApp.swift */; };
 		49E598B827B230AF00C1F2CF /* Preview Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 49E598B727B230AF00C1F2CF /* Preview Assets.xcassets */; };
 		49E598CC27B230AF00C1F2CF /* SingleValueUITests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 49E598CB27B230AF00C1F2CF /* SingleValueUITests.swift */; };
+		94AB9E8C2CE39FDC008967E2 /* SegmentedUITests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 94AB9E8B2CE39FD5008967E2 /* SegmentedUITests.swift */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXContainerItemProxy section */
@@ -60,6 +61,7 @@
 		49E598C727B230AF00C1F2CF /* ExampleUITests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = ExampleUITests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
 		49E598CB27B230AF00C1F2CF /* SingleValueUITests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SingleValueUITests.swift; sourceTree = "<group>"; };
 		49E598DB27B2312500C1F2CF /* swiftui-pick-better */ = {isa = PBXFileReference; lastKnownFileType = wrapper; name = "swiftui-pick-better"; path = ..; sourceTree = "<group>"; };
+		94AB9E8B2CE39FD5008967E2 /* SegmentedUITests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SegmentedUITests.swift; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -177,6 +179,7 @@
 		49E598CA27B230AF00C1F2CF /* ExampleUITests */ = {
 			isa = PBXGroup;
 			children = (
+				94AB9E8B2CE39FD5008967E2 /* SegmentedUITests.swift */,
 				4994CA8727EE729C00F54306 /* MutliValueUITests.swift */,
 				49E598CB27B230AF00C1F2CF /* SingleValueUITests.swift */,
 				4994CA6F27EE23C100F54306 /* SingleOptionalValueTests.swift */,
@@ -403,6 +406,7 @@
 				49A241AE2800E7BA003DD15F /* XCUIElement+Trigger.swift in Sources */,
 				4994CA7027EE23C100F54306 /* SingleOptionalValueTests.swift in Sources */,
 				4994CA8027EE2B6E00F54306 /* XCUIElementQuery+ExactlyOneMatching.swift in Sources */,
+				94AB9E8C2CE39FDC008967E2 /* SegmentedUITests.swift in Sources */,
 				4994CA8927EE72B300F54306 /* MutliValueUITests.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;

diff --git a/Example/ExampleUITests/ExampleUITestCase.swift b/Example/ExampleUITests/ExampleUITestCase.swift
@@ -79,6 +79,10 @@ class ExampleUITestCase: XCUITestCase {
         try allElements().matching(identifier: "multiValueSectionNavItem").firstMatch
     }
 
+    func segmentedNavItem() throws -> XCUIElement {
+        try allElements().matching(identifier: "segmentedNavItem").firstMatch
+    }
+
     func singleValuePicker() throws -> XCUIElement {
         try allElements().matching(identifier: "singleValuePicker").exactlyOneMatch()
     }
@@ -91,6 +95,25 @@ class ExampleUITestCase: XCUITestCase {
         try allElements().matching(identifier: "multiValuePicker").exactlyOneMatch()
     }
 
+    func segmentedPicker() throws -> XCUIElement {
+        try allElements().matching(identifier: "segmentedPicker").firstMatch
+    }
+
+    func segmentedButtonZero() throws -> XCUIElement {
+        try allElements().children(matching: .button)
+            .element(matching: elementCompoundOrPredicate(labeled: ["Segmented 0"]))
+    }
+
+    func segmentedButtonOne() throws -> XCUIElement {
+        try allElements().children(matching: .button)
+            .element(matching: elementCompoundOrPredicate(labeled: ["Segmented 1"]))
+    }
+
+    func segmentedButtonTwo() throws -> XCUIElement {
+        try allElements().children(matching: .button)
+            .element(matching: elementCompoundOrPredicate(labeled: ["Segmented 2"]))
+    }
+
     func cellZero() throws -> XCUIElement {
         try allElements().children(matching: .cell)
             .element(matching: elementCompoundOrPredicate(labeled: ["Cell - 0", "Cell - 0, Selected"]))

diff --git a/Example/ExampleUITests/SegmentedUITests.swift b/Example/ExampleUITests/SegmentedUITests.swift
@@ -0,0 +1,65 @@
+// SegmentedUITests.swift
+// PickBetter
+//
+// Copyright © 2024 MFB Technologies, Inc. All rights reserved. All rights reserved.
+//
+// This source code is licensed under the MIT license found in the
+// LICENSE file in the root directory of this source tree.
+
+import XCTest
+#if os(iOS)
+    import Example
+#elseif os(macOS)
+    import Example_macOS
+#endif
+
+final class SegmentedUITests: ExampleUITestCase {
+    @MainActor
+    override var _sectionNavItem: (@MainActor () throws -> XCUIElement)? {
+        segmentedNavItem
+    }
+
+    @MainActor
+    override var _picker: (@MainActor () throws -> XCUIElement)? {
+        segmentedPicker
+    }
+
+    func testSelectSegmentedPickerItems() async throws {
+        _ = try sectionNavItem().waitForExistence(timeout: 1)
+        XCTAssert(try sectionNavItem().exists, "Navigation link/tab for 'Segmented' picker must exist")
+        try sectionNavItem().trigger()
+
+        _ = try picker().waitForExistence(timeout: 1)
+        XCTAssert(try picker().exists, "Segmented picker must exist")
+        _ = try segmentedButtonZero().waitForExistence(timeout: 1)
+        _ = try segmentedButtonOne().waitForExistence(timeout: 1)
+
+        XCTAssert(try segmentedButtonZero().exists, "Cell Zero must exist")
+        XCTAssert(try segmentedButtonOne().exists, "Cell One must exist")
+        XCTAssert(
+            try segmentedButtonZero().isSelected && (!segmentedButtonOne().isSelected),
+            "Initial state should have cell Zero selected"
+        )
+
+        try segmentedButtonOne().trigger()
+        XCTAssert(try segmentedButtonOne().isSelected, "'1' should be selected after being tapped")
+        XCTAssert(try !segmentedButtonZero().isSelected, "'0' should not be selected before being tapped.")
+
+        try segmentedButtonTwo().trigger()
+        XCTAssert(
+            try segmentedButtonTwo().isSelected,
+            "'2' should still be selected without being tapped again to deselect"
+        )
+        XCTAssert(try !segmentedButtonOne().isSelected, "'1' should be selected after being tapped.")
+
+        try segmentedButtonOne().trigger()
+        XCTAssert(
+            try segmentedButtonOne().isSelected,
+            "'1' should still be selected without being tapped again to deselect"
+        )
+        XCTAssert(
+            try !segmentedButtonTwo().isSelected,
+            "'2' should no longer be selected after being tapped again to deselect"
+        )
+    }
+}
diff --git a/Example/Shared/Sources/Shared/ContentView.swift b/Example/Shared/Sources/Shared/ContentView.swift
@@ -60,6 +60,7 @@ public struct ContentView: View {
     private var singleSectionNavItem: String { "singleValueSectionNavItem" }
     private var singleOptionalSectionNavItem: String { "singleOptionalValueSectionNavItem" }
     private var multiSectionNavItem: String { "multiValueSectionNavItem" }
+    private var segmentedNavItem: String { "segmentedNavItem" }
 
     // MARK: Content
 
@@ -111,6 +112,22 @@ public struct ContentView: View {
         #endif
     }
 
+    private func segmentedPicker() -> some View {
+        SegmentedPickerView(items: Array(items.prefix(3)))
+    }
+
+    private var segmentedNavLabel: some View {
+        #if os(iOS)
+            Image(systemName: "s.circle")
+        #elseif os(macOS) || os(tvOS)
+            HStack {
+                Image(systemName: "n.circle")
+                Text("Segmented")
+            }
+            .font(.title)
+        #endif
+    }
+
     private func navigationButton<Label>(label: Label, tag: TabOption, id: String) -> some View where Label: View {
         accessibleNavigation(tag: tag, id: id) {
             #if os(iOS)
@@ -162,6 +179,7 @@ public struct ContentView: View {
                     id: singleOptionalSectionNavItem
                 )
                 navigationButton(label: multiValueNavLabel, tag: .multiValue, id: multiSectionNavItem)
+                navigationButton(label: segmentedNavLabel, tag: .segmented, id: segmentedNavItem)
                 Spacer()
             }
             .frame(width: 75)
@@ -174,6 +192,7 @@ public struct ContentView: View {
                     id: singleOptionalSectionNavItem
                 )
                 navigationButton(label: multiValueNavLabel, tag: .multiValue, id: multiSectionNavItem)
+                navigationButton(label: segmentedNavLabel, tag: .segmented, id: segmentedNavItem)
             }
         #elseif os(tvOS)
             TabView {
@@ -202,6 +221,8 @@ public struct ContentView: View {
                 singleOptionalValue()
             case .multiValue:
                 multiValue()
+            case .segmented:
+                segmentedPicker()
             }
             Spacer()
         }

diff --git a/Example/Shared/Sources/Shared/SegmentedPicker.swift b/Example/Shared/Sources/Shared/SegmentedPicker.swift
@@ -0,0 +1,44 @@
+// SegmentedPicker.swift
+// PickBetter
+//
+// Copyright © 2024 MFB Technologies, Inc. All rights reserved. All rights reserved.
+//
+// This source code is licensed under the MIT license found in the
+// LICENSE file in the root directory of this source tree.
+
+import Foundation
+import PickBetter
+import SwiftUI
+
+public struct SegmentedPickerView: View {
+    private let items: [Item]
+    @State private var selection: Item.ID = 0
+
+    public init(items: [Item]) {
+        self.items = items
+    }
+
+    // MARK: Accessibility Ids
+
+    private var segmentedPickerString: String { "segmentedPicker" }
+
+    public struct SegmentedItemLabel: View {
+        private let itemId: Int
+
+        public init(itemId: Int) {
+            self.itemId = itemId
+        }
+
+        public var body: some View {
+            Text("Segmented \(itemId)")
+        }
+    }
+
+    public var body: some View {
+        LazyView(
+            BetterPicker(items, selection: $selection, content: { SegmentedItemLabel(itemId: $0.id) })
+                .betterPickerStyle(SegmentedBetterPickerStyle(frameWidth: 500.0))
+                .accessibilityIdentifier(segmentedPickerString)
+        )
+    }
+}
diff --git a/Example/Shared/Sources/Shared/TabOption.swift b/Example/Shared/Sources/Shared/TabOption.swift
@@ -12,4 +12,5 @@ public enum TabOption: Hashable, Sendable {
     case singleValue
     case singleOptionalValue
     case multiValue
+    case segmented
 }
diff --git a/Sources/PickBetter/BetterPicker.swift b/Sources/PickBetter/BetterPicker.swift
@@ -52,6 +52,7 @@ public struct BetterPicker<SelectionBox, ItemContent>: View where SelectionBox:
             listOutput: AnyView(forEachStyledItems),
             cellCount: items.count,
             selectionCount: selection.count,
+            selectionIndexSet: IndexSet(items.enumerated().filter { selection.contains($1.0) }.map(\.offset)),
             selectionLabels: items.filter { selection.contains($0.0) }.map { AnyView($0.1()) }
         )
         let styledBody = style.makeView(configuration)

diff --git a/Sources/PickBetter/BetterPickerStyleCellConfiguration.swift b/Sources/PickBetter/BetterPickerStyleCellConfiguration.swift
@@ -12,10 +12,10 @@ import SwiftUI
 /// Configuration payload passed to `BetterPickerStyle.makeListCell(_:)`
 public struct BetterPickerStyleListCellConfiguration {
     /// Callback for when the cell is selected
-    private let select: () -> Void
+    public let select: () -> Void
 
     /// Callback for when the cell is deselected
-    private let deselect: () -> Void
+    public let deselect: () -> Void
 
     /// Label for the cell
     public let label: () -> AnyView

diff --git a/Sources/PickBetter/BetterPickerStyleConfiguration.swift b/Sources/PickBetter/BetterPickerStyleConfiguration.swift
@@ -20,6 +20,9 @@ public struct BetterPickerStyleConfiguration {
     /// The number of selections
     public let selectionCount: Int
 
+    /// The indicies of all selected items
+    public let selectionIndexSet: IndexSet
+
     /// The label views for the selected cells
     public let selectionLabels: [AnyView]
 }