SwiftNavigation

Table of Contents

Overview

Key Features

Requirements

Installation

Xcode

Package.swift

dependencies: [
 .package(url: "https://github.com/Erikote04/SwiftNavigation", from: "1.0.0")
]

Quick Start

1. Define Routes

import SwiftNavigation
enum AppRoute: String, NavigationRoute {
 case home
 case detail
 case settings
}
enum AppModalRoute: String, NavigationRoute {
 case login
 case terms
}

2. Create a Coordinator

import SwiftNavigation
@MainActor
let coordinator = NavigationCoordinator<AppRoute, AppModalRoute>(scope: .application)

3. Build the Routing Container

import SwiftUI
import SwiftNavigation
@MainActor
struct AppRootView: View {
 @State private var coordinator = NavigationCoordinator<AppRoute, AppModalRoute>(scope: .application)
 var body: some View {
 RoutingView(
 coordinator: coordinator,
 root: {
 HomeView(
 onOpenDetail: { coordinator.push(.detail) },
 onOpenLogin: { coordinator.present(.login, style: .sheet) }
 )
 },
 stackDestination: { route in
 switch route {
 case .home:
 HomeView(onOpenDetail: {}, onOpenLogin: {})
 case .detail:
 DetailView()
 case .settings:
 SettingsView()
 }
 },
 modalDestination: { route in
 switch route {
 case .login:
 LoginView()
 case .terms:
 TermsView()
 }
 }
 )
 .navigationCoordinator(coordinator)
 }
}

MVVM-C Decoupling

import SwiftNavigation
@MainActor
protocol AuthRouting: AnyObject {
 func showTerms()
 func finishLogin()
}
@MainActor
final class AuthRouter: AuthRouting {
 private let router: NavigationRouterProxy<AppRoute, AppModalRoute>
 init(coordinator: NavigationCoordinator<AppRoute, AppModalRoute>) {
 self.router = NavigationRouterProxy(coordinator: coordinator)
 }
 func showTerms() {
 router.present(.terms, style: .fullScreen)
 }
 func finishLogin() {
 router.dismissTopModal()
 router.push(.home)
 }
}

State Restoration

let snapshot = coordinator.exportState()
let data = try JSONEncoder().encode(snapshot)
let restored = try JSONDecoder().decode(
 NavigationState<AppRoute, AppModalRoute>.self,
 from: data
)
coordinator.restore(from: restored)

Deep Linking

import Foundation
import SwiftNavigation
struct URLResolver: URLDeepLinkResolving {
 func navigationState(for url: URL) throws -> NavigationState<AppRoute, AppModalRoute> {
 if url.host == "settings" {
 return NavigationState(stack: [.home, .settings])
 }
 return NavigationState(stack: [.home])
 }
}
try coordinator.applyURLDeepLink(URL(string: "myapp://settings")!, resolver: URLResolver())

Testing

import Testing
@testable import SwiftNavigation
@Test @MainActor
func pushAndPop() {
 let coordinator = NavigationCoordinator<AppRoute, AppModalRoute>(scope: .feature(name: "test"))
 coordinator.push(.home)
 coordinator.push(.detail)
 #expect(coordinator.stack == [.home, .detail])
 _ = coordinator.pop()
 #expect(coordinator.stack == [.home])
}

Documentation