{"id":15170604,"url":"https://github.com/canopas/uipilot","last_synced_at":"2025-04-06T00:10:11.072Z","repository":{"id":38307980,"uuid":"460215180","full_name":"canopas/UIPilot","owner":"canopas","description":"The missing typesafe SwiftUI navigation library","archived":false,"fork":false,"pushed_at":"2024-02-23T09:30:31.000Z","size":1796,"stargazers_count":297,"open_issues_count":12,"forks_count":24,"subscribers_count":7,"default_branch":"main","last_synced_at":"2024-04-14T12:13:35.550Z","etag":null,"topics":["ios","ios-ui","macos","navigation","navigationview","router","routing","swift","swift5","swiftui","xcode"],"latest_commit_sha":null,"homepage":"https://canopas.github.io/UIPilot","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/canopas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-16T23:40:24.000Z","updated_at":"2024-08-06T00:34:25.194Z","dependencies_parsed_at":"2024-08-06T00:34:23.470Z","dependency_job_id":"79caf09f-c864-4a7c-9c7e-3f5cb7166c44","html_url":"https://github.com/canopas/UIPilot","commit_stats":{"total_commits":88,"total_committers":4,"mean_commits":22.0,"dds":"0.31818181818181823","last_synced_commit":"15b33aebc9c302b181897bcb415064ce48ec0eaf"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/canopas%2FUIPilot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/canopas%2FUIPilot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/canopas%2FUIPilot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/canopas%2FUIPilot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/canopas","download_url":"https://codeload.github.com/canopas/UIPilot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247415973,"owners_count":20935387,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ios","ios-ui","macos","navigation","navigationview","router","routing","swift","swift5","swiftui","xcode"],"created_at":"2024-09-27T08:04:13.210Z","updated_at":"2025-04-06T00:10:11.049Z","avatar_url":"https://github.com/canopas.png","language":"Swift","readme":"\u003cp align=\"center\"\u003e \u003ca href=\"https://canopas.com/contact\"\u003e\u003cimg src=\"./docs/assets/canopas_light_banner.png\"\u003e\u003c/a\u003e\u003c/p\u003e\n\n# UIPilot\n\n[![Swift](https://img.shields.io/badge/Swift-5.5-orange?style=flat-square)](https://img.shields.io/badge/Swift-5.5-Orange?style=flat-square)\n[![Platforms](https://img.shields.io/badge/Platforms-macOS_iOS_tvOS_watchOS-yellowgreen?style=flat-square)](https://img.shields.io/badge/Platforms-macOS_iOS_tvOS_watchOS-Green?style=flat-square)\n[![Swift Package Manager](https://img.shields.io/badge/Swift_Package_Manager-compatible-orange?style=flat-square)](https://img.shields.io/badge/Swift_Package_Manager-compatible-orange?style=flat-square)\n\n\u003cimg src=\"https://github.com/canopas/UIPilot/blob/main/docs/assets/intro-image.jpg?raw=true\" height=\"350\" /\u003e\n\n## Why another SwiftUI navigation library?\n- 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.\n- APIs are inspired by the Android, flutter, and web-based routers - Very simple and easy to use.\n- Typesafe navigation - Routing to the wrong path will fail at compile time rather than runtime.\n- Typesafe parameters - Routing with wrong parameters will fail at compile time rather than runtime.\n- Very tiny library - it's barely 200 lines of code.\n\n## Documentation\nVisit [the website](https://canopas.github.io/UIPilot/) for documentation and more information.\n\n## Examples\nPlease 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.\n\n## Complex use cases\nThe library is designed to meet simple use cases as well as complex ones. You can also have nested `UIPilot` as many as you like!\n\nFor example, it's very easy to achieve split screen-like behavior.\n\n\u003cimg src=\"https://github.com/canopas/UIPilot/blob/main/docs/assets/complex-routing.gif?raw=true\" height=\"500\" /\u003e\n\nPlease have a look at the [article](https://blog.canopas.com/swiftui-complex-navigation-made-easier-with-uipilot-5b33279f3476) for more information of the implementation.\n\n## Installation\n\nVersion 1.x - Uses SwiftUI `NavigationView` underneath.\n\nVersion 2.x - Uses UIKit `UINavigationController` underneath (recommended).\n\n### Swift Package Manager\n\nThe [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. \n\nOnce 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`.\n\n```swift\ndependencies: [\n    .package(url: \"https://github.com/canopas/UIPilot.git\", .upToNextMajor(from: \"2.0.2\"))\n]\n```\n\n### CocoaPods\n\n[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:\n\n    target 'YourAppName' do\n        pod 'UIPilot', '~\u003e 2.0.2'\n    end\n\n[CocoaPods]: https://cocoapods.org\n\n## Contribution\n\nThe 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](CONTRIBUTING.md) 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.\n\n# Bugs and Feedback\nFor bugs, questions, and discussions please use the [Github Issues](https://github.com/canopas/UIPilot/issues).\n\n# Credits\n\nUIPilot is owned and maintained by the [Canopas](https://canopas.com/) team. You can follow them on X at [@canopassoftware](https://x.com/canopassoftware) for project updates and releases.\n\n\u003ca href=\"https://canopas.com/contact\"\u003e\u003cimg src=\"https://github.com/canopas/UIPilot/assets/73588408/6d691a53-e495-4783-b510-76ae4d692201\" width=250\u003e\u003c/a\u003e\n\n# Licence\n\nUIPilot is released under the MIT license. See [LICENSE](https://github.com/canopas/UIPilot/blob/main/LICENSE.md) for details.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcanopas%2Fuipilot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcanopas%2Fuipilot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcanopas%2Fuipilot/lists"}