Fixes #317 - Adopt a split layout for iPad and Mac apps

Rename navigation components: SplitScreenCoordinator -> NavigationSplitCoordinator, StackScreenCoordinator -> NavigationStackCoordinator and SingleScreenCoordinator -> NavigationRootCoordinator [0c161039] Tweak navigation logging [826c19cf] Move the navigation dismissal callbacks to the NavigationModule, add SingleScreenCoordinator tests [b8830d9c] Add tests [252ad119] Merge the StackScreenCoordinator and SplitScreenCoordinators into a single file and stop publicly exposing their internal workings. Add more documentation. [37671699] Cleanup navigation logging [51406184] Use the parent SplitScreenCoordinator to present embedded StackScreenCoordinator sheets [b94b04c9] Retract the room "syncing" indicator when dismissing a room [1467b0ac] Correctly move to the no room selected state when popping in compact layouts [10bf2ad8] Allow nilling root coordinators, replace present/dismiss sheet with setSheetCoordinator(?) [33716784] Add single screen coordinator fade transition animation [3cbe65e7] Prevent the timeline table view from being reused between different rooms [9c94c50b] Move files around [c10b6bc5] Adapt the user session state machine to the split layout [7115a319] Fix unit and UI tests [1ece59e8] Fix login flows [6884dc3b] Use modules everywhere the underlying object is a NavigationModule [ab08d44c] Rename navigation components to: SingleScreenCoordinator, SplitScreenCoordinator and StackScreenCoordinator [ada2be57] Add SplitNavigationController * Remove the navigationRootCoordinator from the UserSessionFlowCoordinator
2026-11-02 12:07:55 +00:00 · 2022-12-12 12:31:27 +02:00
parent 5ef53e9220
commit cd40da6c3f
22 changed files with 1407 additions and 541 deletions
@@ -0,0 +1,82 @@
+//
+// Copyright 2022 New Vector 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 SwiftUI
+
+class NavigationRootCoordinator: ObservableObject, CoordinatorProtocol, CustomStringConvertible {
+    @Published fileprivate var rootModule: NavigationModule? {
+        didSet {
+            if let oldValue {
+                oldValue.coordinator.stop()
+                oldValue.dismissalCallback?()
+            }
+            
+            if let rootModule {
+                logPresentationChange("Set root", rootModule)
+                rootModule.coordinator.start()
+            }
+        }
+    }
+    
+    /// The currently displayed coordinator
+    var rootCoordinator: (any CoordinatorProtocol)? {
+        rootModule?.coordinator
+    }
+    
+    /// Sets or replaces the presented coordinator
+    /// - Parameter coordinator: the coordinator to display
+    func setRootCoordinator(_ coordinator: (any CoordinatorProtocol)?, dismissalCallback: (() -> Void)? = nil) {
+        guard let coordinator else {
+            rootModule = nil
+            return
+        }
+        
+        rootModule = NavigationModule(coordinator, dismissalCallback: dismissalCallback)
+    }
+        
+    // MARK: - CoordinatorProtocol
+    
+    func toPresentable() -> AnyView {
+        AnyView(NavigationRootCoordinatorView(rootCoordinator: self))
+    }
+    
+    // MARK: - CustomStringConvertible
+    
+    var description: String {
+        if let rootCoordinator = rootModule?.coordinator {
+            return "SingleScreenCoordinator(\(rootCoordinator)"
+        } else {
+            return "SingleScreenCoordinator(Empty)"
+        }
+    }
+    
+    // MARK: - Private
+    
+    private func logPresentationChange(_ change: String, _ module: NavigationModule) {
+        MXLog.info("\(self) \(change): \(module.coordinator)")
+    }
+}
+
+private struct NavigationRootCoordinatorView: View {
+    @ObservedObject var rootCoordinator: NavigationRootCoordinator
+    
+    var body: some View {
+        ZStack {
+            rootCoordinator.rootModule?.coordinator.toPresentable()
+        }
+        .animation(.elementDefault, value: rootCoordinator.rootModule)
+    }
+}