Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexdremov/pathpresenter
Pure SwiftUI state-driven library to present view sequences and hierarchies.
https://github.com/alexdremov/pathpresenter
architecture ios ios-swift ios-ui mvvm routing swift swift-package-manager swift-ui swiftui swiftui-animations swiftui-demo swiftui-example swiftui-framework
Last synced: about 1 month ago
JSON representation
Pure SwiftUI state-driven library to present view sequences and hierarchies.
- Host: GitHub
- URL: https://github.com/alexdremov/pathpresenter
- Owner: alexdremov
- Created: 2022-07-24T19:32:08.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-10T19:35:20.000Z (over 1 year ago)
- Last Synced: 2024-06-12T15:32:57.077Z (7 months ago)
- Topics: architecture, ios, ios-swift, ios-ui, mvvm, routing, swift, swift-package-manager, swift-ui, swiftui, swiftui-animations, swiftui-demo, swiftui-example, swiftui-framework
- Language: Swift
- Homepage:
- Size: 32.2 KB
- Stars: 72
- Watchers: 6
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PathPresenter
[](https://www.codacy.com/gh/AlexRoar/PathPresenter/dashboard?utm_source=github.com&utm_medium=referral&utm_content=AlexRoar/PathPresenter&utm_campaign=Badge_Grade)
https://user-images.githubusercontent.com/25539425/181922855-3ff3aa77-757b-4091-b682-63456fe963a1.mp4
Pure SwiftUI routing with transitions, animations, and `.sheet()` support.
In SwiftUI, View is a function of the state. Routing is not an exception. Reasoning and under the hood explanation can be found on my blog:
http://alexdremov.me/swiftui-navigation-is-a-mess-heres-what-you-can-do/
## Why
- `.sheet()` usages are usually messy, deviate from app architecture, and require additional business-logic
- Creating view sequences in SwiftUI is not elegant
- MVVM is gorgeous, but what about one level above? Routing between MVVM modules is cluttered.
## Advantages
- **Purely state-driven**.
No ObservableObjects, no EnvironmentObjects, no Singletons.
- **Pure SwiftUI**.
- **SwiftUI transitions and animations**.
- **Structured `.sheet()` support**.
No need to remaster the whole codebase to present the view with `.sheet()`. It just works.
## Example
Example from the video: [PathPresenterExample](https://github.com/AlexRoar/PathPresenterExample/tree/main)
The view hierarchy is managed through the `PathPresenter.Path()` structure.
You can push new views into it using `.append` methods and delete views from the top using `.removeLatest`.
Internally, the view's layout is managed by `ZStack`, so all views history is visible.
Possible presentation ways:
```swift
enum PathType {
/**
* Just show a view. No animation, no transition.
* Show view above all other views
*/
case plain
/**
* Show view with in and out transitions.
* Transition animation also can be specified.
*/
case animated(transition: AnyTransition, animation: Animation)
/**
* Show view in .sheet()
* - Note: If you want to present several views in sheet,
* you can create a second RoutingView and use it in sheet!
*/
case sheet(onDismiss: Action)
}
```
Complete example:
```swift
struct RootViewGitHub: View {
@State var path = PathPresenter.Path()
var body: some View {
PathPresenter.RoutingView(path: $path) {
// Root view. Always presented
VStack {
Button("Push") {
path.append(
VStack {
Text("Hello from plain push")
backButton
}.frame(width: 300, height: 300)
.background(.white)
.border(.red),
type: .plain
)
}
Button("Sheet") {
path.append(
VStack {
Text("Hello from sheet")
backButton
}.frame(width: 300, height: 300)
.background(.white)
.border(.red),
type: .sheet(onDismiss: {print("dismissed")})
)
}
Button("Left animation") {
path.append(
VStack {
Text("Hello from left animation")
backButton
}.frame(width: 300, height: 300)
.background(.white)
.border(.red),
type: .animated(transition: .move(edge: .leading),
animation: .easeIn)
)
}
}
.frame(width: 300, height: 300)
}
}
var backButton: some View {
Button("Back") {
if !path.isEmpty {
path.removeLast()
}
}
}
}
```
## Transitions and animation example
## Documentation
Code is mostly commented and simply structured. Check it out!
## TODO
- **Path-based routing**. Define view hierarchy with URL-like structures for better views switching architecture