Loading repository data…
ozontech / repository
Simple SwiftUI Navigation component. Alternate NavigationStack with supporting from iOS 14. We are fixing all know Apple bugs and performance drop. Compatible with Routing, Coordinator and each other architecture patterms. This navigation has functions of getting and applying the URL which allows you to organize deep links without special costs.
A transparent discovery signal based on current public GitHub metadata.
This score does not audit code, security, maintainers, documentation quality, or suitability. Verify the repository and its current documentation before adoption.
Simple navigation framework for SwiftUI. Alternative NavigationStack with support for iOS 14, Apple bug fixes and better features. Compatible with Routing, Coordinator and each other architecture patterns. This navigation framework has functions of getting and applying the URL which allows you to organize deep links without special costs. In addition, the package contains a separate public test framework SUINavigationTest for testing navigation with unit tests and snapshot tests. We care about quality and performance what why we have UI and Unit tests.
Now Developers have standard navigation framework SwiftUI. "Correct" navigation features were introduced since iOS 16 as NavigationStack, but developers can not use that becase should support a iOS 14.x as target commonly. Now we have solutions to backport NavigationStack: NavigationBackport but it's too bold and different from the declarative approach. We want a simpler interface. In addition, the NavigationStack and NavigationBackport havn't many functions such as skip and each others. Functions append and replace from SUINavigation with URL allows store and backup navigation state without special costs. Also allows you to use deep links as an additional feature in this SwiftUI navigation component. If you want to use microfeature-architecture you can inject views to your modules closed by value object type.
Selected from shared topics, language and repository description—not editorial ratings.
POIKUS-LLC /
PKSNavigation is a simple yet powerful navigation framework designed for SwiftUI applications. It helps you manage complex navigation flows with ease, supporting stack-based navigation, sheet presentations, and full-screen covers.
55/100 healthNote that the framework consists of several libraries. The SUINavigation library is needed to use navigation in the application, and SUINavigationTest is needed to cover unit tests, if you try to use SUINavigationTest to compile the application, you will most likely encounter linking errors.
Once you have your Swift package set up, adding SUINavigation as a dependency is as easy as adding it to the dependencies value of your Package.swift. And next step: add library to targets. For the application target you should use SUINavigation library and for tests target you should use SUINavigationTest library.
dependencies: [
.Package(url: "https://github.com/ozontech/SUINavigation.git", majorVersion: 1)
],
targets: [
.target(
name: "YourApp",
dependencies: [
.product(name: "SUINavigation", package: "SUINavigation"),
],
),
.testTarget(
name: "YourTests",
dependencies: [
.product(name: "SUINavigationTest", package: "SUINavigation"),
],
),
],
You can integrate SUINavigation into your project from Xcode.
To do this you need to go to Project of the root of Project Navigator, then choose tab Package Dependencies and when you click add enter the path to this repository. You will then be prompted to add certain libraries to the targets, it is important to choose the right targets based on your usage goals, as mentioned at the beginning of the installation article. Note that the example below shows adding to the application target and test target. If you specify the wrong targets, you may experience linking errors.
If you didn't use tests, then for SUINavigationTest in screen above you need setup Add to Target to None.
For tests on popular iOS versions you just call script:
sh Scripts/release.sh
The same script can prepare release with detection version from CHANGELOG and you can use it for tag new version. For the creating release notes I use GL, installed and setup and call next script:
brew install gh
gh auth login
sh Scripts/releasenotes.sh
Just open Example/NavigationExample/NavigationExample.xcodeproj from Xcode and you can build, test this from IDE.
Use NavigationStorageView instead of NavigationView or NavigationStack.
In parent view use modifiers .navigation(..) with string id param or without (for using struct name) in addition features as in the code below.
.navigation(..) applies to all content in the view being navigated from. This modifier should not be allowed to apply to child elements of that view, such as childs of ListView, LazyView and each others. Better use .navigation(..) below of all content of that view as in the code below.
import SwiftUI
import SUINavigation
struct RootView: View {
// True value trigger navigation transition to FirstView
@State
private var isShowingFirst: Bool = false
var body: some View {
NavigationStorageView{
VStack {
Text("Root")
Button("to First"){
isShowingFirst = true
}
}.navigation(isActive: $isShowingFirst){
FirstView()
}
}
}
}
struct FirstView: View {
// Not null value trigger navigation transition to SecondView with this value, nil value to dissmiss to this View.
@State
private var optionalValue: Int? = nil
var body: some View {
VStack(spacing: 0) {
Text("First")
Button("to Second"){
optionalValue = 777
}
}.navigation(item: $optionalValue, id: "second"){ item in
// item is unwrapped optionalValue where can used by SecondView
SecondView(number: item)
}
}
}
struct SecondView: View {
@State
private var isShowingLast: Bool = false
var body: some View {
VStack(spacing: 0) {
Text("Second")
Button("to Last"){
isShowingLast = true
}
}.navigation(isActive: $isShowingLast, id: "last"){
SomeView()
}
}
}
struct SomeView: View {
// This optional everywhere, because in a test can use NavigationView without navigationStorage object
@OptionalEnvironmentObject
private var navigationStorage: NavigationStorage?
// Standard feature of a dissmiss works too. Swipe to right works too.
@Environment(\.presentationMode)
private var presentationMode
var body: some View {
Button("Go to First") {
// You should use struct for navigate, because it determinate without id
navigationStorage?.popTo(FirstView.self)
}
Button("Go to SecondView") {
// You should use id for navigate to SecondView, because it determinate as id
navigationStorage?.popTo("second")
}
Button("Go to Root") {
navigationStorage?.popToRoot()
}
Button("Skip First") {
navigationStorage?.skip(FirstView.self)
}
Button("Skip Second") {
navigationStorage?.skip("second")
}
}
}
SUINavigation is a SwiftUI navigation component that includes SUINavigationTest test library, which allows you to cover your views navigation rooting with Unit and Snapshot tests without use Router or Coordinator architecture approach.
More details about why this is needed and how to implement it are written in a separate article SUINavigationTest.
The Next example just shows how to write tests:
import SUINavigationTest
final class NavigationExampleTests: XCTestCase {
/// Unit Test
func testView1ToView2() throws {
let view1 = View1()
test(sourceView: view1, destinationView: View2.self) {
view1.triggerValue = "trigger"
} destination: { view2 in
XCTAssertEqual(view2.inputValue, "trigger")
}
}
/// Snapshot Test
func testAllItemsOfTheRoot() throws {
let rootView = RootView()
try assertItemsSnapshot(rootView)
}
}
SUINavigation has functions of getting and applying the URL which allows you to organize deep links without special costs. Modifier .navigationAction identical .navigation, but support navigate by append or replace from URL (URI). If you want custom navigate or use presentation type of navigation (alert, botomsheet, fullScreenCover, TabBar, etc) you can use part of .navigationAction as .navigateUrlParams. Modifiers .navigationAction as .navigateUrlParams have addition sets of params for customisation an URL representation.
More about Deeplinks in separated article page Deeplinks.
The Next example just shows how to navigate from url:
import SwiftUI
import SUINavigation
struct SomeView: View {
@OptionalEnvironmentObject
private var navigationStorage: NavigationStorage?
@State
private var optionalValue: Int? = nil
let url = "second?secondValue=777"
var body: some View {
VStack() {
Text("Some")
Button("to Second from URL"){
navigationStorage.append(url)
}
}.navigationAction(item: $optionalValue, id: "second", paramName: "secondValue") { item in
SecondView(number: item)
}
}
}
Since NavigationStack don't support nested NavigationStack it affected to NavigationStorageView too. But it reproduced on iOS 16 and leter. On iOS 15.x and lower it work fine because NavigationView haven't this problem.
You can also seporate nested NavigationStorageView with help another navigation for example .fullScreenCover or TabBar then you can use fearlessly nested NavigationStorageView even with iOS 16 and leter. For this case, we even provided support for deep links of nested navigation.
NavigationStorage has mirror functions for supporting the Coordinator pattern. I show You how does it differ from the classical approach with SwiftUI:
View's with and binding to special value type. For that use .navigationStorageBinding modifier before triger navigation..navigation modifier with some View as destination to the same .navigation modifier with this special value type as destination. An Enum can be used as this value type.
enum Destination: Equatable {
case first(String)
case second(Int)
case bool
}
struct RootView: View {
var body: some View {
NavigationStorageView{
ZStack{
mainView
}.navigationStorageBinding(for: Destination.self) { destination in
switch self {
case .first(let string):
ModularFirstView(string: string)
case .second(let number):
ModularSecondView(number: number)
case .bool:
ModularBoolView()
}
}
}
}
}
struct ModularFirstView: View {
@State
private var numberForSecond: Int? = nil
var body: some View {
ZStack {
VStack {
Text("This is First")
Button("to Second with 22") {
numberForSecond = 22
}
}
}
.navigationAction(item: $numberForSecond) { num