Contents

canopas/UIPilot

The missing typesafe SwiftUI navigation library

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 for documentation and more information.

Examples

Please have a look at the article and the 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.

<img src="https://github.com/canopas/UIPilot/blob/main/docs/assets/complex-routing.gif?raw=true" height="500" />

Please have a look at the article 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 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.

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

Contribution

The Canopas team enthusiastically welcomes contributions and project participation! There are a bunch of things you can do if you want to contribute! The Contributor Guide has all the information you need for everything from reporting bugs to contributing entire new features. Please don't hesitate to jump in if you'd like to, or even ask us questions if something isn't clear.

Bugs and Feedback

For bugs, questions, and discussions please use the Github Issues.

Credits

UIPilot is owned and maintained by the Canopas team. You can follow them on X at @canopassoftware for project updates and releases.

<a href="https://canopas.com/contact"><img src="https://github.com/canopas/UIPilot/assets/73588408/6d691a53-e495-4783-b510-76ae4d692201" width=250></a>

Licence

UIPilot is released under the MIT license. See LICENSE for details.

Package Metadata

Repository: canopas/UIPilot

Homepage: https://canopas.github.io/UIPilot

Stars: 314

Forks: 29

Open issues: 18

Default branch: main

Primary language: swift

License: MIT

Topics: ios, ios-ui, macos, navigation, navigationview, router, routing, swift, swift5, swiftui, xcode

README: README.md