What's New

1.0.0

2024-05-22T23:11:59Z

What's Changed

Full Changelog: 0.7.0...1.0.0


NavigationView Logo

Navigation made simple

Improve the navigation in your project in no time. Keep your code clean

Try demo we prepared | Roadmap | Propose a new feature


Designed for SwiftUI Platforms: iOS Current Version License: MIT

Made in Kraków Follow us on X Let's work together Stargazers

NavigationView Examples NavigationView Examples NavigationView Examples NavigationView Examples


NavigationView by Mijick is a powerful, open-source library dedicated for SwiftUI that makes navigation process super easy and much cleaner.

  • Custom animations. Our library provides full support for any animation.
  • Remembers the current scroll view offset. Library automatically saves the current scroll view offset when you leave the view.
  • Improves code quality. Navigate through your screens with just one line of code. Focus on what’s important to you and your project, not on Swift's intricacies.
  • Stability at last! At Mijick, we are aware of the problems that were (and still are) with the native NavigationView and how many problems it caused to developers. Therefore, during the development process we put the greatest emphasis on the reliability and performance of the library.
  • Designed for SwiftUI. While developing the library, we have used the power of SwiftUI to give you powerful tool to speed up your implementation process.

Getting Started

✋ Requirements

Platforms Minimum Swift Version
iOS 15+ 5.0

⏳ Installation

Swift package manager is a tool for automating the distribution of Swift code and is integrated into the Swift compiler.

Once you have your Swift package set up, adding NavigationView as a dependency is as easy as adding it to the dependencies value of your Package.swift.

dependencies: [
    .package(url: "https://github.com/Mijick/NavigationView", branch(“main”))
]

Cocoapods is a dependency manager for Swift and Objective-C Cocoa projects that helps to scale them elegantly.

Installation steps:

pod init
  • Add CocoaPods dependency into your Podfile
pod 'MijickNavigationView'
  • Install dependency and generate .xcworkspace file
pod install
  • Use new XCode project file .xcworkspace

Usage

1. Setup library

Inside your @main structure, call the implementNavigationView method with the view that is to be the root of the navigation stack. The view must be of type NavigatableView. The method takes an optional argument - config, which can be used to configure certain attributes of all the views that will be placed in the navigation stack.

@main struct NavigationView_Main: App {
    var body: some Scene {
        WindowGroup {
            ContentView()
               .implementNavigationView(config: nil)                    
        }
    }
}

2. Declare a view to be pushed to the navigation stack

NavigationView by Mijick provides the ability to push any view conforming to the NavigatableView protocol to the navigation stack.

struct ExampleView: NavigatableView {
    ...
}

3. Implement body

Fill your view with content

struct ExampleView: NavigatableView {    
    var body: some View {
        VStack(spacing: 0) {
            Text("Witaj okrutny świecie")
            Spacer()
            Button(action: pop) { Text("Pop") } 
        }
    }
    ...
}

4. Implement configure(view: NavigationConfig) -> NavigationConfig method

This step is optional - if you wish, you can skip this step and leave the configuration as default.
Each view has its own set of methods that can be used to create a unique look for each view in the stack.

struct ExampleView: NavigatableView {   
    func configure(view: NavigationConfig) -> NavigationConfig { view.backgroundColour(.red) }
    var body: some View {
        VStack(spacing: 0) {
            Text("Witaj okrutny świecie")
            Spacer()
            Button(action: pop) { Text("Pop") } 
        }
    }
    ...
}

5. Present your view - from any place in your code!

Just call ExampleView().push(with:) from the selected place. As simple as that!

struct SettingsViewModel {
    ...
    func openSettings() {
        ...
        ExampleView().push(with: .verticalSlide)
        ...
    }
    ...
}

6. Close your view - it's even simpler!

There are two ways to do this:

  • By calling one of the methods pop, pop(to type:), popToRoot inside any view
struct ExampleView: NavigatableView {
    ...
    func createButton() -> some View {
        Button(action: popToRoot) { Text("Tap to return to root") } 
    }
    ...
}
  • By calling one of the static NavigationManager methods:
    • NavigationManager.pop()
    • NavigationManager.pop(to type:) where type is the type of view you want to return to
    • NavigationManager.popToRoot()

7. Wait, there's even more!

We're almost done, but we'd like to describe three additional methods that you might like:

  • With the setAsNewRoot method you can change the root of your navigation stack:
ExampleView()
    .push(with: .verticalSlide)
    .setAsNewRoot()
  • EnvironmentObject can be passed, but remember to do this BEFORE pushing the view to the stack:
ExampleView()
    .environmentObject(object)
    .push(with: .verticalSlide)
  • Use onFocus, not onAppear
    If you want to be notified every time a view is visible (is on top of the stack), use onFocus method:
struct ExampleView: NavigatableView {    
    var body: some View {
        VStack(spacing: 0) {
            Text("Witaj okrutny świecie")
            Spacer()
            Button(action: pop) { Text("Pop") } 
        }
        .onFocus(self) {
            // Do something
        }
    }
    ...
}

Try our demo

See for yourself how does it work by cloning project we created

License

NavigationView is released under the MIT license. See LICENSE for details.



Our other open source SwiftUI libraries

PopupView - The most powerful popup library that allows you to present any popup
CalendarView - Create your own calendar object in no time
GridView - Lay out your data with no effort
CameraView - The most powerful CameraController. Designed for SwiftUI
Timer - Modern API for Timer

Description

  • Swift Tools 5.8.0
View More Packages from this Author

Dependencies

  • None
Last updated: Sat Jun 15 2024 00:55:25 GMT-0900 (Hawaii-Aleutian Daylight Time)