https://github.com/fluidgroup/swiftui-stack
Yet another Navigation Stack + Transition
https://github.com/fluidgroup/swiftui-stack
swiftui
Last synced: 12 months ago
JSON representation
Yet another Navigation Stack + Transition
- Host: GitHub
- URL: https://github.com/fluidgroup/swiftui-stack
- Owner: FluidGroup
- License: apache-2.0
- Created: 2023-05-07T13:03:31.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-06-09T05:44:57.000Z (about 1 year ago)
- Last Synced: 2025-07-13T01:07:26.010Z (12 months ago)
- Topics: swiftui
- Language: Swift
- Homepage: https://fluidgroup.github.io/swiftui-stack/documentation/swiftuistack/
- Size: 10.2 MB
- Stars: 87
- Watchers: 4
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Custom Stack Navigation for SwiftUI
---
This library provides a custom container view for SwiftUI that offers an alternative to the standard NavigationStack. It aims to improve the customizability of transitions during screen navigation by moving away from the behaviors of UINavigationController and UINavigationBar.
Features
---
- Customizable transitions during screen navigation
- Contextual animations similar to iOS home screen app icons and app screens
- Familiar API to NavigationView and NavigationStack for ease of use
- Path support for restoring previously navigated views
Getting Started
---
To use this library, you'll need to work with three main symbols: Stack, StackLink, and StackUnwindLink.
Example Usage
---
1. Import the SwiftUIStack module in your SwiftUI view file:
```swift
import SwiftUIStack
```
2. Use the Stack container in your view hierarchy:
```swift
var body: some View {
Stack {
// Your views here...
}
}
```
3. Create navigation links using StackLink with your desired transition and destination:
```swift
StackLink(transition: .slide, value: someValue) {
Text("Navigate to detail view")
}
```
You can also set the matched transition in the transition parameter using a unique identifier and a namespace:
```swift
StackLink(transition: .matched(identifier: user.id, in: local), value: someValue) {
Text("Navigate to detail view with matched transition")
}
```
4. Optionally, use StackUnwindLink to create a navigation link back to the previous view:
```swift
StackUnwindLink {
Text("Back to previous view")
}
```
Unwind Context
---
In stacked views, you can access the unwindContext as an EnvironmentValue. You can pass the unwindContext to a StackUnwindLink. This allows you to explicitly specify the stack that triggers the unwind.
```swift
@Environment(\.stackUnwindContext) var unwindContext
StackUnwindLink(target: .specific(unwindContext)) {
Text("Back to Menu")
}
```
StackUnwindLink Modes
---
StackUnwindLink now supports different modes for navigation. To navigate back to the root of the target stack, use the .all mode.
```swift
StackUnwindLink(mode: .all) {
Text("Back to Root")
}
```
Nested Stacks
---
This technique is useful for nested stacks when you need to send a message across multiple levels of the hierarchy. By using the unwindContext in conjunction with StackUnwindLink, you can effectively communicate between nested stacks and navigate through different levels of the view hierarchy.
Installation
---
This library currently only supports installation via Swift Package Manager.
To add the package to your project, you can manually add it to your Package.swift file:
```swift
dependencies: [
.package(url: "https://github.com/FluidGroup/swiftui-stack.git", from: "1.0.0")
]
```
Contributing
---
(Include instructions for contributing to the project, such as opening issues, submitting pull requests, and any other relevant information)
License
---
This project is licensed under the Apache License, Version 2.0. See the [LICENSE](LICENSE) file for more information.