SwiftUIRouter

 

A lightweight SwiftUI routing framework using registration-based decoupling, supporting URL Schemes and Universal Links.

Features

• Decoupling: Zero coupling between modules through registration mechanism
• Native SwiftUI Support: Designed specifically for SwiftUI
• Multi-scenario Support:
  • In-app routing
  • URL Scheme navigation
  • Universal Links handling
• Navigation Control:
  • Tab switching
  • View dismissal (single, all, or modal-only)

Installation

Swift Package Manager

Add the dependency to your Package.swift:

dependencies: [
    .package(url: "https://github.com/jyo2206208/SwiftUIRouter.git", from: "x.x.x")
]

Usage

1. Register Routers for your View

extension HotelListView: RouteHandler {

    static var path: String { "hotellist" }

    static func view(for destination: RouteDestination) -> HotelListView? {
        HotelListView()
    }
}

// Second, register it after launch
Router.register(handlers: [
    HotelListView.self
])

2. Add router ability

// add router ability for a rootView
var body: some View {
    HomeView().router(.root())
}

// add router ability for a TabView based app
@State private var selectedTab = 0
var body: some View {
    let routerTuples: [(RootTabs, Router)] = RootTabs.allCases.map {
        ($0, .root($selectedTab))
    }
    TabView(selection: $selectedTab) {
        ForEach(routerTuples, id: \.0) { tab, router in
            Router.rootView(for: tab.rawValue)
                .router(router)
                .tabItem { Label(tab.title, systemImage: tab.image) }
                .tag(tab.rawValue)
        }
    }
}

// If you want handler URL just add .openURL function
var body: some View {
    let routerTuples: [(RootTabs, Router)] = RootTabs.allCases.map {
        ($0, .root($selectedTab))
    }
    TabView(selection: $selectedTab) {
        ForEach(routerTuples, id: \.0) { tab, router in
            Router
                .rootView(for: tab.rawValue)
                .router(router)
                .tabItem { Label(tab.title, systemImage: tab.image) }
                .tag(tab.rawValue)

        }
    }.onOpenURL { url in
        guard routerTuples.count > selectedTab else { return }
        let pathString = url.pathString
        let param = url.compactQueryParameters
        routerTuples[selectedTab].1.navigate(to: pathString, type: .push, param: param)
    }
}

• Navigation

 struct HomeView: View {
    
    @Environment(\.router) var router
    @Environment(\.openURL) var openURL
    
    var body: some View {
        Button("goto hotel list") {
            router.navigate(to: "hotellist")
        }
        Button("Open URL: swiftuirouter://deeplink/hotellist") {
            openURL(URL(string: "swiftuirouter://deeplink/hotellist")!)
        }
        Button("goto me") {
            router.switchTab(to: 3)
        }
    }
}

• Dismiss

Button("dismiss") {
    router.dismiss()
}
Button("dismissAll") {
    router.dismissAll()
}
Button("dismissAllModal") {
    router.dismissAllModal()
}

License

MIT.