Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/canopas/UIPilot
The missing typesafe SwiftUI navigation library
https://github.com/canopas/UIPilot
ios ios-ui macos navigation navigationview router routing swift swift5 swiftui xcode
Last synced: 29 days ago
JSON representation
The missing typesafe SwiftUI navigation library
- Host: GitHub
- URL: https://github.com/canopas/UIPilot
- Owner: canopas
- License: mit
- Created: 2022-02-16T23:40:24.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-23T09:30:31.000Z (10 months ago)
- Last Synced: 2024-04-14T12:13:35.550Z (8 months ago)
- Topics: ios, ios-ui, macos, navigation, navigationview, router, routing, swift, swift5, swiftui, xcode
- Language: Swift
- Homepage: https://canopas.github.io/UIPilot
- Size: 1.71 MB
- Stars: 297
- Watchers: 7
- Forks: 24
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# UIPilot
[](https://img.shields.io/badge/Swift-5.5-Orange?style=flat-square)
[](https://img.shields.io/badge/Platforms-macOS_iOS_tvOS_watchOS-Green?style=flat-square)
[](https://img.shields.io/badge/Swift_Package_Manager-compatible-orange?style=flat-square)
## Why another SwiftUI navigation library?
- UIPilot is not a replacement for SwiftUI's `NavigationView`, it's rather a wrapper around it that you would have likely written. Thus all standard `NavigationView` features like title, swipe gesture, topbar, etc. are available by default.
- APIs are inspired by the Android, flutter, and web-based routers - Very simple and easy to use.
- Typesafe navigation - Routing to the wrong path will fail at compile time rather than runtime.
- Typesafe parameters - Routing with wrong parameters will fail at compile time rather than runtime.
- Very tiny library - it's barely 200 lines of code.
## Documentation
Visit [the website](https://canopas.github.io/UIPilot/) for documentation and more information.
## Examples
Please have a look at the [article](https://blog.canopas.com/swiftui-complex-navigation-made-easier-with-uipilot-5b33279f3476) and the [examples](https://github.com/canopas/UIPilot/tree/main/Examples) to know more about different use cases of UIPilot.
## Complex use cases
The library is designed to meet simple use cases as well as complex ones. You can also have nested `UIPilot` as many as you like!
For example, it's very easy to achieve split screen-like behavior.
Please have a look at the [article](https://blog.canopas.com/swiftui-complex-navigation-made-easier-with-uipilot-5b33279f3476) for more information of the implementation.
## Installation
Version 1.x - Uses SwiftUI `NavigationView` underneath.
Version 2.x - Uses UIKit `UINavigationController` underneath (recommended).
### Swift Package Manager
The [Swift Package Manager](https://swift.org/package-manager/) is a tool for automating the distribution of Swift code and is integrated into the `swift` compiler.
Once you have your Swift package set up, adding UIPilot as a dependency is as easy as adding it to the `dependencies` value of your `Package.swift`.
```swift
dependencies: [
.package(url: "https://github.com/canopas/UIPilot.git", .upToNextMajor(from: "2.0.2"))
]
```
### CocoaPods
[CocoaPods][] is a dependency manager for Cocoa projects. For usage and installation instructions, visit their website. To integrate UIPilot into your Xcode project using CocoaPods, specify it in your Podfile:
target 'YourAppName' do
pod 'UIPilot', '~> 2.0.2'
end
[CocoaPods]: https://cocoapods.org
# Bugs and Feedback
For bugs, questions, and discussions please use the [Github Issues](https://github.com/canopas/UIPilot/issues).
# Credits
UIPilot is owned and maintained by the [Canopas](https://canopas.com/) team. You can follow them on Twitter at [@canopassoftware](https://twitter.com/canopassoftware) for project updates and releases.
# Licence
UIPilot is released under the MIT license. See [LICENSE](https://github.com/canopas/UIPilot/blob/main/LICENSE.md) for details.