Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ernest0-production/screennavigatorkit
Framework that provide convenient environment for manage navigation in SwiftUI
https://github.com/ernest0-production/screennavigatorkit
ios spm swift swiftui xcode
Last synced: 15 days ago
JSON representation
Framework that provide convenient environment for manage navigation in SwiftUI
- Host: GitHub
- URL: https://github.com/ernest0-production/screennavigatorkit
- Owner: Ernest0-Production
- License: mit
- Created: 2022-04-17T13:15:32.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-01T18:17:56.000Z (about 1 year ago)
- Last Synced: 2025-01-17T19:45:31.334Z (15 days ago)
- Topics: ios, spm, swift, swiftui, xcode
- Language: Swift
- Homepage:
- Size: 37.1 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
 
# ScreenNavigatorKit
Framework that provide convenient environment for manage navigation in SwiftUI.
## Pros:
- 🤢 No boolean flag such as `@State var isActive`
- 🤮 No `enum` flag such as `@State var route: RouteAction?` with big `switch-case` statement
- 🤡 No implicit `UIKit` hacks with `UIViewController`
- 💩 No singleton/shared/global presenter of application
### 🔩 Requirements
- iOS 14.0+
- Xcode 12.0+
- Swift 5.3+
# 🧐 How does it work?!
Framework has only two `state object`, each of which isolates "toggle-work" of `@State var isActive: Bool` and `@State var isPresent: Bool` flags.
## 1. `NavigationStackController`
Like `UINavigationController`, it **store stack state** and **provide stack transformation** using `push` and `pop` methods:
```swift
let navigationStackController = NavigationStackController()
// Standard usage
navigationStackController.push(Text("My View"))
navigationStackController.pop()
navigationStackController.popToRoot()
// Advanced usage
enum Screen: Hashable {
case detail
...
}
navigationStackController.push(tag: Screen.detail, DetailView())
navigationStackController.pop(to: Screen.detail)
```
Its companion is `NavigationStackView` – wrapper over `NavigationView` that bind `NavigationStackController` with it:
```swift
struct ContentView: View {
@StateObject var navigationStackController = NavigationStackController()
var body: some View {
NavigationStackView(navigationStackController) {
RootView(
showDetails: { model in
navigationStackController.push(DetailView(model: model))
},
showSettings: {
navigationStackController.push(SettingsView())
}
)
}
}
}
// Another usage with automatic initialized NavigationStackController
struct ContentView: View {
var body: some View {
NavigationStackView { controller in
RootView(
showDetails: { model in
controller.push(DetailView(model: model))
},
showSettings: {
controller.push(SettingsView())
}
)
}
}
}
```
Any pushed view has access to `NavigationStackController` of `NavigationStackView` through `EnvironmentObject`:
```swift
struct DetailView: View {
let model: Model
@EnvironmentObject var navigationStackController: NavigationStackController
var body: some View {
VStack {
Text(model.title)
Button("pop to root") {
navigationStackController.popToRoot()
}
}
}
}
```
**💫 EXTRA FEATURE:** You can tag any pushed view using any `Hashable` type. It allow refer to specific screen on pop:
```swift
navigationStackController.push(tag: "Screen 1", Screen1()))
navigationStackController.pop(to: "Screen 1")
```
## 2. `ModalStackController`
Like `NavigationStackController`, the `ModalStackController` **control modal stack hierarchy** and **provide stack transformation** using `present` and `dismiss` methods:
```swift
let modalStackController = ModalStackController()
// Standard usage
modalStackController.present(.sheet, Text("My View"))
modalStackController.present(.fullScreenCover, Text("Another View"))
modalStackController.dismiss()
modalStackController.dismissAll()
// Advanced usage
enum Screen: Hashable {
case detail
...
}
modalStackController.present(.sheet, tag: Screen.detail, DetailView())
modalStackController.dismiss(to: Screen.detail)
```
**🚧 NOTE:** `SwiftUI` does not allow to dismiss multiple views at once! Therefore, methods such as `dismissAll()` or `dismiss(to:)`/`dismiss(from:)` will close all views **sequentially**.
Its companion is `ModalStackView` that bind `ModalStackController` with it:
```swift
struct ExampleApp: App {
@StateObject var modalStackController = ModalStackController()
var body: some Scene {
WindowGroup {
ModalStackView(modalStackController) {
RootView()
}
}
}
}
```
Any presented view has access to `ModalStackController` through `EnvironmentObject` too:
```swift
struct RootView: View {
@EnvironmentObject var modalStackController: ModalStackController
var body: some View {
VStack {
Text("Home screen")
Button("FAQ") {
modalStackController.present(.sheet, FAQView())
}
Button("Authorize") {
modalStackController.present(.fullScreenCover, LoginView())
}
}
}
}
```
> 💫 Just like in `NavigationStackController` you can tag presented views when present with `ModalStackController`
# API
`NavigationStackController`
- push
- push(tag:)
- pop
- pop(tag:)
- popLast(_ k:)
- popToRoot
`ModalStackController`
- present(_ presentationStyle:)
- present(_ presentationStyle:tag:)
- dismiss
- dismiss(tag:)
- dismissLast(_ k:)
- dismissAll
- `PresentationStyle`
- sheet
- fullScreenCover
# FAQ
### Can i mix this framework with existing navigation approach in my project?
**Yes, you can**. The framework does not affect navigation built in other ways, such as through the standard `@State var isActive: Bool` flags or through UIKit hacks.\
`NavigationStackController` and `ModalStackController` create local state and manage only their own state.
### What about `Alert`?
Unfortunately, the framework **does not support** such a mechanism for working with `Alert`, BUT **you can implement it yourself by analogy** with `ModalStackController`.\
Your project can have many different custom presentations (`popup`, `snackbar`, `toast`, `notifications`) and each of them require specific logic for handle hierarchy, depending on their implementation.\
So adding new presentation methods to the framework **is not planned**.
# 📦 Installation
#### [Swift Package Manager](https://github.com/apple/swift-package-manager)
Create a `Package.swift` file.
```swift
// swift-tools-version:5.3
import PackageDescription
let package = Package(
name: "YOUR_PROJECT_NAME",
dependencies: [
.package(url: "https://github.com/Ernest0-Production/ScreenNavigatorKit.git", from: "0.0.3")
],
targets: [
.target(name: "YOUR_TARGET_NAME", dependencies: ["ScreenNavigatorKit"])
]
)
```
### Credits
- [Telegram](https://t.me/Ernest0n)
### License
ScreenNavigatorKit is released under the MIT license. See [LICENSE](https://github.com/Ernest0-Production/ScreenNavigatorKit/blob/main/LICENSE.md) for details.