Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/timoliver/beeline
An extremely lean implementation on the classic iOS router pattern.
https://github.com/timoliver/beeline
ios mac-catalyst swift tvos uikit
Last synced: 2 months ago
JSON representation
An extremely lean implementation on the classic iOS router pattern.
- Host: GitHub
- URL: https://github.com/timoliver/beeline
- Owner: TimOliver
- Created: 2021-07-17T06:42:56.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-24T15:03:51.000Z (almost 2 years ago)
- Last Synced: 2024-10-14T21:51:47.783Z (3 months ago)
- Topics: ios, mac-catalyst, swift, tvos, uikit
- Language: Swift
- Homepage:
- Size: 210 KB
- Stars: 61
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/TimOliver/Beeline/actions?query=workflow%3ACI)
[](http://cocoadocs.org/docsets/Beeline)
[](https://raw.githubusercontent.com/TimOliver/Beeline/main/LICENSE)
[](http://cocoadocs.org/docsets/Beeline)
Beeline is a very small library that aims to provide a lean, automatic implementation of the classic iOS router pattern. It extends `UIViewController` to retain a `Router` object that serves as the source of truth for controlling navigation flows for all of the view controller's children. When a child view controller wishes to transition to a new screen, it can call `show()` on itself and this request is passed up the view controller chain to the routing view controller.
# Instructions
A very basic custom implementation looks as the following. First, we create a Swift enum conforming to `Route` where we can define the types of destinations with which we want to move:
```swift
enum AppRoute: Route {
case viewController(number: Int)
}
```
Thanks to Swift associated enums, we can also include any custom parameters the new destination may need.
We then also make a new class which subclasses `Router`, which serves as our single point of truth for controlling the app flow based off the destinations we defined above:
```swift
public class AppRouter: Router {
override func show(_ route: Route,
from sourceViewController: UIViewController?) -> Bool {
// Optionally, filter out routes we don't support
guard let appRoute = route as? AppRoute else { return false }
// Check the requested enum, and perform the transition
switch appRoute {
case .viewController(let number):
let newViewController = ViewController(number: number)
sourceViewController?
.navigationController?
.pushViewController(newViewController, animated: true)
}
return true
}
}
```
Using Objective-C associated objects, we can assign this router to any parent view controller that contains all of the view controllers that might want to perform these transitions:
```swift
let navigationController = UINavigationController(rootViewController: ViewController())
navigationController.router = AppRouter()
```
Finally, without any further modification to any of the child view controllers, they can start a transition by simply calling `show()` with the desired destination:
```swift
class ViewController: UIViewController {
func moveToNewViewController() {
show(AppRoute.viewController(number: 2))
}
}
```
And that's the entire library! 🎉
# Requirements
* Swift 5
* UIKit-compatible platforms (iOS, tvOS, Mac Catalyst)
# Installation
Beeline is a very small framework, with all of its code contained in `Router.swift`. You can install it in the following ways:
## Manual Installation
Drag the `Beeline/Router.swift` file into your Xcode project.
### CocoaPods
```
pod 'Beeline'
```
### SPM
You can add Beeline to an Xcode project by adding it as a package dependency.
https://github.com/TimOliver/Beeline
or, add the following to the dependencies in package.swift.
```swift
dependencies: [
.package(url: "https://github.com/TimOliver/Beeline", from: "1.0.2")
]
```
### Carthage
No plans to support Carthage at the moment, but please consider filing a PR if you would like it!
# Credits
Beeline was built as a component of iComics 2 by [Tim Oliver](https://twitter.com/TimOliverAU)
# License
Beeline is available under the MIT License. Please check the [LICENSE](LICENSE) file for more information.