Eirias / GoodCoordinator-iOS

🧭 Simplified programmatic navigation in SwiftUI

GoodCoordinator

🧭 Programmatic navigation made simple, 100% SwiftUI

In just 3 lines of code

@Push(makeHome) var home
func makeHome(model: HomeModel) -> HomeView { HomeView(model: model) }

route(to: \.home, HomeModel(username: username, password: password))

Usage

1. Implement a SwiftUI App

   @main struct NavigationApp: App {
       private let coordinator = AppCoordinator(())
   
       var body: some Scene {
           WindowGroup {
               coordinator.makeView()
           }
       }
   }

   This is a standard implementation for a 100% SwiftUI app.

2. Implement your first coordinator

   import GoodCoordinator
   
   final class AppCoordinator: NavigationCoordinator {
       typealias Input = Void
       typealias Output = Void
       var state: NavigationStack = .init()
   
       @Root(makeRoot) var root
   
       func makeRoot() -> InitialView {
           InitialView() /// SwiftUI View!
       }
   }

   Don't worry about code you don't understand yet. Feel free to name the makeRoot function in any way you prefer. The function returns the view of your choice. However, to get this code to compile, you need to do one more thing:

3. Modify your SwiftUI View a bit

   import GoodCoordinator
   
   struct InitialView: View, Screen { /// Extend from Screen as well
       ...

4. Add a navigation step

   @Push(makeNewScreen) var openNewScreen
   
   func makeNewScreen() -> NewScreen {
       NewScreen(viewModel: NewScreenViewModel())
   }

   Add a step into your coordinator and specify, how the view will get constructed.

5. Navigate!

   @EnvironmentObject var router: Router<AppCoordinator>
   
   // SwiftUI view code
   Button(action: {
       router.coordinator.route(to: \.openNewScreen)
   }, label: {
       Text("Go to new screen")
   })
   // More SwiftUI view code

   Launch the navigation step from your view.

Installation

You can use Swift Package Manager (SPM) to import this package. Use the following URL:

https://github.com/GoodRequest/GoodCoordinator-iOS.git

Advanced examples

TBD