carson-katri / router

Type-safe routing in SwiftUI

Hi there 👋

router's Issues

Path translation?

The standard for names in Swift is camelCase, but most websites use kebab-case for URL components. I see three different ways to reconcile this:

1. Stick to camelCase URLs. This means the URLs are likely case sensitive and it would be obvious from the URL that this was not a regular web app.
2. Automatically translate the route names to kebab-case. This would provide standard web app behavior.
3. Allow users to somehow specify custom path components for a given route, overriding the default.

I think a combination of 2 and 3 would be best, providing sensible defaults while allowing users to potentially port existing URLs over to Tokamak, but I’m willing to have my mind changed!

NavigationView integration

I'm not sure how this would work yet, but it would be great if the router either supported the native NavigationView and NavigationLink types or introduced new RoutableNavigation and RoutableLink (names to bikeshed) types that behaved in a similar way with support for NavigationView layout and transitions. Maybe it is supported already? I haven't had a chance to explore the source code yet, feel free to close this then.

RouterDemo.xcodeproj is missing

The xcworkspace is present but the xcodeproj isn’t so there’s no way to run the demo.

Cant seem to install package

Updating https://github.com/carson-katri/router
Updating https://github.com/wickwirew/Runtime
Updating https://github.com/swiftwasm/JavaScriptKit.git
Updating https://github.com/TokamakUI/Tokamak
Updating https://github.com/TokamakUI/OpenCombine.git
Updating https://github.com/swiftwasm/OpenCombineJS.git
Everything is already up-to-date
[1/55] Compiling OpenCombine DebugHook.swift
/Users/jimmyhoughjr/Documents/nscbr/.build/checkouts/router/Sources/Router/Helpers/EnvironmentObject+exists.swift:1:8: error: no such module 'SwiftUI'
import SwiftUI
^
[2/69] Compiling OpenCombine FilterProducer.swift
/Users/jimmyhoughjr/Documents/nscbr/.build/checkouts/router/Sources/Router/Helpers/EnvironmentObject+exists.swift:1:8: error: no such module 'SwiftUI'
import SwiftUI
^
[3/120] Compiling OpenCombine ConnectablePublisher.swift
/Users/jimmyhoughjr/Documents/nscbr/.build/checkouts/router/Sources/Router/Helpers/EnvironmentObject+exists.swift:1:8: error: no such module 'SwiftUI'
import SwiftUI
^
[4/120] Compiling OpenCombine CurrentValueSubject.swift
/Users/jimmyhoughjr/Documents/nscbr/.build/checkouts/router/Sources/Router/Helpers/EnvironmentObject+exists.swift:1:8: error: no such module 'SwiftUI'
import SwiftUI
^
[5/120] Compiling OpenCombine Codable.swift
/Users/jimmyhoughjr/Documents/nscbr/.build/checkouts/router/Sources/Router/Helpers/EnvironmentObject+exists.swift:1:8: error: no such module 'SwiftUI'
import SwiftUI
^
[6/120] Compiling OpenCombine CombineIdentifier.swift
/Users/jimmyhoughjr/Documents/nscbr/.build/checkouts/router/Sources/Router/Helpers/EnvironmentObject+exists.swift:1:8: error: no such module 'SwiftUI'
import SwiftUI
^
[7/120] Compiling OpenCombine AnySubscriber.swift
/Users/jimmyhoughjr/Documents/nscbr/.build/checkouts/router/Sources/Router/Helpers/EnvironmentObject+exists.swift:1:8: error: no such module 'SwiftUI'
import SwiftUI
^
[8/120] Compiling OpenCombine Cancellable.swift
/Users/jimmyhoughjr/Documents/nscbr/.build/checkouts/router/Sources/Router/Helpers/EnvironmentObject+exists.swift:1:8: error: no such module 'SwiftUI'
import SwiftUI
^
[9/120] Compiling OpenCombine CustomCombineIdentifierConvertible.swift
/Users/jimmyhoughjr/Documents/nscbr/.build/checkouts/router/Sources/Router/Helpers/EnvironmentObject+exists.swift:1:8: error: no such module 'SwiftUI'
import SwiftUI
^
[10/120] Compiling OpenCombine Future.swift
/Users/jimmyhoughjr/Documents/nscbr/.build/checkouts/router/Sources/Router/Helpers/EnvironmentObject+exists.swift:1:8: error: no such module 'SwiftUI'
import SwiftUI
^
[11/120] Compiling OpenCombine AnyCancellable.swift
/Users/jimmyhoughjr/Documents/nscbr/.build/checkouts/router/Sources/Router/Helpers/EnvironmentObject+exists.swift:1:8: error: no such module 'SwiftUI'
import SwiftUI
^
[12/120] Compiling OpenCombine AnyPublisher.swift
/Users/jimmyhoughjr/Documents/nscbr/.build/checkouts/router/Sources/Router/Helpers/EnvironmentObject+exists.swift:1:8: error: no such module 'SwiftUI'
import SwiftUI
^
[13/120] Compiling OpenCombine ConduitBase.swift
/Users/jimmyhoughjr/Documents/nscbr/.build/checkouts/router/Sources/Router/Helpers/EnvironmentObject+exists.swift:1:8: error: no such module 'SwiftUI'
import SwiftUI
^
[14/120] Compiling OpenCombine ConduitList.swift
/Users/jimmyhoughjr/Documents/nscbr/.build/checkouts/router/Sources/Router/Helpers/EnvironmentObject+exists.swift:1:8: error: no such module 'SwiftUI'
import SwiftUI

Provide activeRoute Binding

This would, for instance, allow setting the WindowGroup title based on the current Route:

struct MyApp : App {
  @State private var activeRoute: AppRoutes = .defaultRoute
  var body: some Scene {
    WindowGroup(title(for: activeRoute)) {
      Router(activeRoute: $activeRoute) {
        ...
      }
    }
  }
}

Can also open the possibility of navigating programmatically:

struct MyApp : App {
  @State private var activeRoute: AppRoutes = .defaultRoute
  var body: some Scene {
    WindowGroup {
      Router(activeRoute: $activeRoute) {
        ...
      }
    }.onOpenUrl {
      activeRoute = ...
    }
  }
}