Unidirectional data flow driven navigation for SwiftUI applications
This project explores ways to implement navigation in a SwiftUI application, using unidirectional data flow architecture.
- Navigate between views in a similar way that UIKit allows
NavigationStackViewprovides behavior similar toUINavigationControllerNavigationBackGestureprovides "swipe from edge to go back" behavior known fromUINavigationController
- Implementation compatible with unidirectional data flow architecture
NavigationItemprovides an interface for a state of a view user can navigate to[NavigationItem]array is a single source of truth forNavigationStackViewNavigationStackViewcan not mutate the state itself- State changes are visualized by
NavigationStackView
- Easily customizable appearance
- All included views provide a basic implementation that mimics
UINavigationControllerlook and feel, but can be replaced with any custom view if needed - Because no
UINavigationControlleris used under the hood, there are no limitations or issues with appearance customizations in contrast toNavigationViewprovided by SwiftUI
- All included views provide a basic implementation that mimics
| Component | Description |
|---|---|
NavigationItem |
Protocol of a state model that represents an item on navigation stack |
NavigationItemView |
View that represents navigation item |
NavigationItemViewFactory |
Function that creates a view for given navigation item |
NavigationStackView |
View that represents stack of navigation items, as UINavigationController does |
NavigationBarView |
View that represents navigation bar |
NavigationBackButton |
Back button view that can be displayed on navigation bar |
NavigationBackGesture |
View modifier that attaches a "swipe from edge to go back" gesture to the navigation item view |
Simple application with a navigation stack that mimics UINavigationController behavior. From initial, root screen user can go to the first step screen. The step screen allows to navigate to the next step (until step number three, which is the last one) or to go back to the root screen.
State of the navigation stack is modeled as an array of navigation items, hold by a store object. Whenever the array changes, view is updated to display top-most navigation item from the stack. User interface is fully customizable, supports "swipe from edge to go back" gesture and both left-to-right and right-to-left layout directions. The implementation provides some default visual style and animations, but those can be easily customized as well. Everything is written in pure SwiftUI, without using UIViewControllerRepresentable to wrap UINavigationController.
| Component | Description |
|---|---|
Store |
Simplified implementation of store object that holds app's state |
RootState |
State model representation of root screen view |
StepState |
State model representation of step screen view |
| View | Description |
|---|---|
AppView |
Main view of the app containing navigation stack |
RootView |
Root screen view, initial screen of the app |
StepView |
Step screen view |
Requirements:
- Xcode 11.3.1
Open SwiftUINavigation.xcodeproj in Xcode and run the app.
Copyright © 2020 EL Passion
License: GNU GPLv3
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent