Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/JamesSedlacek/Routing
SwiftUI library for abstracting navigation logic from views
https://github.com/JamesSedlacek/Routing
abstraction navigation navigationdestination navigationlink navigationstack routing swiftui
Last synced: 2 months ago
JSON representation
SwiftUI library for abstracting navigation logic from views
- Host: GitHub
- URL: https://github.com/JamesSedlacek/Routing
- Owner: JamesSedlacek
- License: mit
- Created: 2023-12-15T22:59:52.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-19T05:25:13.000Z (7 months ago)
- Last Synced: 2024-08-17T07:36:40.521Z (5 months ago)
- Topics: abstraction, navigation, navigationdestination, navigationlink, navigationstack, routing, swiftui
- Language: Swift
- Homepage:
- Size: 2.34 MB
- Stars: 335
- Watchers: 5
- Forks: 16
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/apple/swift-package-manager)
[](https://github.com/JamesSedlacek/Routing/stargazers)
[](https://github.com/JamesSedlacek/Routing/network)
[](https://github.com/JamesSedlacek/Routing/network)
## Description
`Routing` is a **lightweight** SwiftUI navigation library.
- Leverages 1st-party APIs `NavigationStack` & `NavigationDestination`.
- Never be confused about `NavigationLink` or `NavigationPath` again! (You don't need them)
- Type-Safe Navigation (better performance than type-erasing).
- Centralized Navigation Logic.
- Dynamic Navigation Stack Management.
- Unit Tested protocol implementations.
- Zero 3rd party dependencies.
- [Documentation](https://jamessedlacek.github.io/documentation/routing)
Note - This library is for **NavigationStack** only.
If you need to abstract sheets, alerts, etc. then use my other library [`Presenting`](https://github.com/JamesSedlacek/Presenting)
## Table of Contents
1. [Requirements](#requirements)
2. [Installation](#installation)
3. [Getting Started](#getting-started)
4. [Passing Data Example](#passing-data-example)
5. [Under the hood](#under-the-hood)
6. [Author](#author)
## Requirements
| Platform | Minimum Version |
|----------|-----------------|
| iOS | 16.0 |
| macOS | 13.0 |
| tvOS | 16.0 |
| watchOS | 9.0 |
## Installation
You can install `Routing` using the Swift Package Manager.
1. In Xcode, select `File` > `Add Package Dependencies`.
2. Copy & paste the following into the `Search or Enter Package URL` search bar.
```
https://github.com/JamesSedlacek/Routing.git
```
3. Xcode will fetch the repository & the `Routing` library will be added to your project.
## Getting Started
1. Create a `Route` enum that conforms to the `Routable` protocol.
``` swift
import Routing
import SwiftUI
enum ExampleRoute: Routable {
case detail
case settings
var body: some View {
switch self {
case .detail:
DetailView()
case .settings:
SettingsView()
}
}
}
```
2. Create a `Router` object and wrap your `RootView` with a `RoutingView`.
``` swift
import SwiftUI
import Routing
struct ContentView: View {
@StateObject private var router: Router = .init()
var body: some View {
RoutingView(stack: $router.stack) {
Button("Go to Settings") {
router.navigate(to: .settings)
}
}
}
}
```
3. Handle navigation using the `Router` functions
```swift
/// Navigate back in the stack by a specified count.
func navigateBack(_ count: Int)
/// Navigate back to a specific destination in the stack.
func navigateBack(to destination: Destination)
/// Navigate to the root of the stack by emptying it.
func navigateToRoot()
/// Navigate to a specific destination by appending it to the stack.
func navigate(to destination: Destination)
/// Navigate to multiple destinations by appending them to the stack.
func navigate(to destinations: [Destination])
/// Replace the current stack with new destinations.
func replace(with destinations: [Destination])
```
## Passing Data Example
```swift
import Routing
import SwiftUI
enum ContentRoute: Routable {
case detail(Color)
case settings
var body: some View {
switch self {
case .detail(let color):
ColorDetail(color: color)
case .settings:
SettingsView()
}
}
}
struct ContentView: View {
@StateObject private var router: Router = .init()
private let colors: [Color] = [.red, .green, .blue]
var body: some View {
RoutingView(stack: $router.stack) {
List(colors, id: \.self) { color in
color
.onTapGesture {
router.navigate(to: .detail(color))
}
}
}
}
}
struct ColorDetail: View {
private let color: Color
init(color: Color) {
self.color = color
}
var body: some View {
color.frame(maxWidth: .infinity, maxHeight: .infinity)
}
}
```
## Under the hood
The `RoutingView` essentially is just wrapping your view with a `NavigationStack` & `navigationDestination`.
``` swift
NavigationStack(path: $routes) {
root()
.navigationDestination(for: Routes.self) { view in
view
}
}
```
## Author
James Sedlacek, find me on [X/Twitter](https://twitter.com/jsedlacekjr) or [LinkedIn](https://www.linkedin.com/in/jamessedlacekjr/)