Path based routing in SwiftUI

I use SwiftUIRouter with Composable architecture to make things easier I've added Equatable conformance to Navigator so it can be used inTCA action or state.

• made Navigator Equatable
• added Tests

How can I Create one more navigation stack above tabView?

So I need to present a few different flows under each of tab. But I can't fine approach to do that. I had a look in examples and there is no scenario I need.

I'll explain using one of examples: From one of the tabs I what to navigate further:

How can I push View above tabView, not inside?

Please help)

Currently, I'm doing this:

enum AppRoutes {
    static let splash = "/"
    static let login = "/login"
    static let feed = "/feed"
}

SwitchRoutes {
    Route(AppRoutes.splash) {
        SplashScreenView()
    }
    Route(AppRoutes.feed) {
        FeedView()
    }
    ...
}

Is there any way to make this properly type safe, or at least safer? It seems rather fragile to rely on strings in this manner. Ideally, I wouldn't want to define my own "route enum" and have navigator.navigate accept only that type, etc.

Hi, first of all, congrats about this library, it is very useful.

I wonder whether there is a way to animate switch route changes like the old-styled UIKit NavigationView actually does. Maybe there is a easy way to do it, but I didn't find it.

Thanks in advance

Please provide information or example how to switch between different flows in case when one of the flow contains TabView.

So I have registration flow and main flow with tab bar (I use original swiftUI TabView with TabContents)

And I can't find approach how I can navigate to tabView after registration flow is completed. I get empty TabView. I suppose that's because tabView is a set of routes(views inside) and if I use tabView as root view it's okey. But if I use some empty root view as router that navigates to registration or tabView flow it can't navigate correctly to tabView

Hey! Great work on this library. Really hope it takes off more because it really is a great solution for routing in SwiftUI.

A minor bug I noticed is that while wildcards do not rely on trailing slashes, optional parameters do. So for example, I had

Route("/chats/*")

which would render regardless of whether I was going to /chats or /chats/:chatID. However, if I redefine this as /chats/:chatID?, then navigating to /chats produces an empty screen. Only if I navigate to /chats/ will the SwiftUI component appear.

It's a minor regex fix I imagine, but nevertheless thought I'd raise it. I can help open a fix if you don't have the time :)

Thanks for building this prototype! I learned quite a bit digging through it.

I've been trying to figure out a solution for routing in a fairly large app. I was hoping this type of approach might work, but after digging in it looks to be too limited.

Am I correct in my assumption that I could implement multiple Routers in a project (for each tab, for instance) but that the max amount of Routes per base view would be 10? So if I had a view that had 11 potential destination views, this would not work?

Hoping I'm missing some obvious workaround. Appreciate any of your input. Thanks again!

A much needed package, thank you for bringing this to the community!

Sadly, I ran into an issue on my first run testing things out. It's probably not the most common series of events but here's my setup:

Router {
  SwitchRoutes {
    Route("start") {
      StartView()
    }
    Route {
      NavLink(to: "start") {
        Text("Go to start")
      }
    }
  }
}

1. When app opens, it goes to the catch-all route (as expected).

2. Pressing NavLink takes me to StartView (as expected).

3. StartView uses Navigator EO and a button with one line: navigate(to: "overview"). Tapping that button opens the catch-all route (as expected).

4. When tapping NavLink again I expected it to go to the StartView again. Sometimes it navigates to a blank page and sometimes nothing occurs at all.

Maybe this is the outside the intended functionality, if so I wonder if the documentation could better reflect that.

EDIT: Initially the only result on Step 4 was navigating to a blank screen, so I thought this might be due to how I'm handling my onAppear/onDisappear in StartView. But now it's just staying out and not navigating at all.

I even tried a slightly different example...

Router {
  SwitchRoutes {
    Route("start") {
      StartView()
    }
    Route("overview") {
      NavLink(to: "info") {
        Text("Go to info")
      }
    }
    Route {
      NavLink(to: "start") {
        Text("Go to start")
      }
    }
  }
}

Now it gets to the catch all from "overview", but again nothing happens when tapping NavLink to go to "start".

Imagine the following navigation pattern:

/screen1/:id1 /screen1/:id1/:childId1 /screen1/:id1/:childId1/subchildId1 ...

And I want all these paths to be routed to a single screen (it's like going down a filesystem). I've tried doing screen1/* - this catches all these navigations but doesn't give me parameters screen1/*/:id - doesn't work :id - doesn't work for nested navigations either

Hence I'm taking a temporary solution of forking the library and making RouteInformation.matchedPath public to analyze it in code (which is not the best way to solve this, of course).

What do you think would be the proper way to support this (fairly common I guess) scenario? Thanks!

Hello, I am new to SwiftUI, I have a page A with a Button, when I press the Button, I want navigate to PageB, I don't know how to write the Route, can you help me, thanks.

Hi and thanks for a very nice library!

I am wondering if it would be possible to navigate between two and three without one being rerendered?

The way we use this is that the view model of one handles data fetching and is then passed to two (and three) via .environemntObject(). But when navigating between those one is recreated on all navigation steps as well.

@main
struct MyApp: App {	
	var body: some Scene {
		WindowGroup {
			Router(initialPath: "/one/two/three") {
				Route(path: "/one/*") {
					Text("One")

					Route(path: "/one/two/*") {
						Text("Two")

						Route(path: "/one/two/three") {
							Text("Three")
						}
					}
				}
			}
		}
	}
}

Have SwifUIRouter in packages. Error during build on CI: xcodebuild[70128:54646963] [MT] IDEFileReferenceDebug: [Load] <IDESwiftPackageCore.IDESwiftPackageSpecialFolderFileReference, 0x6000007fbb00: name:SwiftUIRouter.docc path:group:SwiftUIRouter.docc> Failed to load container at path: /Users/gitlab-runner/Library/Developer/Xcode/DerivedData/iosApp-asfxiubzkohtrkgwfpdkjwugwcjj/SourcePackages/checkouts/SwiftUIRouter/Sources/SwiftUIRouter.docc, Error: Error Domain=com.apple.dt.IDEContainerErrorDomain Code=6 "Cannot open "SwiftUIRouter.docc" as a "Swift Package Folder" because it is already open as a "Folder"." UserInfo={NSLocalizedDescription=Cannot open "SwiftUIRouter.docc" as a "Swift Package Folder" because it is already open as a "Folder".}

Have spent a lot of time to fix it. Possibly this is Xcode bug. https://github.com/kean/Nuke/issues/609#issuecomment-1287798474 Guys who faced with similar issue just removed .docc folder from project while it is not fixed by Apple. Can we do the same for SwiftUIRouter? have no ideas at all how to fix it

Is there a way to keep some paths loaded in memory, i.e. not recreate the views when the path changes?

I was implementing a tab bar layout like in the RandomUsers example, but with this solution the pages get recreated every time the user switches tab, which can make the process of switching tab a bit laggy.

Is there a way to keep those pages in memory to provide a smooth tab bar experience?

Note: this would also allow keeping states, like scrolling positions. It just feels more natural.

I followed the doc Animating Routes and tried to replace the transition with .opacity, but it doesn't work. When using .move(edge: .bottom).combined(with: .opacity), only the move transition is executed.

My requirement is: Switch to another tab then push to a certain view under navigation view then finally present a modal?

How can I config routing for this case?

Thanks

I expect back stack to work same as in system navigation: view states from the back stack should be saved.

It includes saving @State and @StateObject annotated objects, but I can think of workaround how I can store them manually.

The main think is scroll view position - in SwiftUI it's impossible to scroll to contentOffset, if we're using basic ScrollView, so I can't even store scroll position and restore it when view appears, unless I write my own scroll view.

Here's a basic example to reproduce:

1. Run the app
2. Scroll the list
3. Click Next button to navigate
4. Click Back button to navigate back
5. Scroll position is reset.

@EnvironmentObject private var navigator: Navigator

var body: some View {
	SwitchRoutes {
		Route("/settings") {
			Button {
				navigator.goBack()
			} label: {
				Text("back")
			}
		}
		Route {
			Text(navigator.path)
			Button {
				navigator.navigate("/settings")
			} label: {
				Text("next")
			}
			ScrollView {
				ForEach(0..<100, id: \.self) { i in
					Text("\(i)")
				}
			}
		}
	}
}

A possible workaround would be having all the screens from the back stack in the view tree - e.g. in ZStack, one on top of an other one. But this for sure would break onAppear/onDisappear, as well as transitions.

I'm using SwiftUIRouter library on company Product, and encounter this issue frequently. https://github.com/frzi/SwiftUIRouter/issues/39

I think that it is better to designate the Rotue's View id as self.path directly in the library than to individually.