NavigationKit - SwiftUI Navigation Framework

Overview

NavigationKit is a modern SwiftUI navigation framework that provides a clean, coordinator-based architecture for managing complex navigation flows in iOS applications.

View on GitHub Documentation

Key Features

🎯 Coordinator Pattern

Clean separation of navigation logic from view presentation.

🔒 Type-Safe Navigation

Compile-time safety for all navigation operations.

📱 Multiple Styles

Push, sheet, full-screen, and custom presentations.

🔗 Deep Link Support

Built-in deep link handling with easy integration.

⚡ SwiftUI Native

Designed specifically for SwiftUI with iOS 16+.

🛡️ Thread-Safe

MainActor compliance ensures thread-safe operations.

Quick Start

// Add to your Package.swift
dependencies: [
    .package(url: "https://github.com/dimzfresh/NavigationKit.git", from: "1.0.0")
]

Basic Usage

@MainActor
final class MainCoordinator: BaseCoordinator {
    @Published var childCoordinator: (any Coordinator)?
    @Published var navigationRouters: [NavigationRouter] = []
    
    var rootView: some View {
        NavigationStack(path: rootNavigationRouter.pathBinding) {
            HomeView()
                .navigationDestination(for: NavigableView.self) { navigableView in
                    navigableView.view
                }
        }
        .onAppear {
            setupNavigationRouter()
        }
    }
}

Architecture

┌─────────────────────────────────────────────────────────────┐ │ NavigationKit Architecture │ ├─────────────────────────────────────────────────────────────┤ │ │ │ ┌─────────────────┐ ┌─────────────────┐ │ │ │ Coordinator │ │ BaseCoordinator │ │ │ │ (Protocol) │◄───┤ (Protocol) │ │ │ └─────────────────┘ └─────────────────┘ │ │ │ │ │ │ │ ▼ │ │ │ ┌─────────────────┐ │ │ │ │NavigationRouter │ │ │ │ │ (Class) │ │ │ │ └─────────────────┘ │ │ │ │ │ │ │ ▼ │ │ │ ┌─────────────────┐ │ │ │ │ NavigableView │ │ │ │ │ (Struct) │ │ │ │ └─────────────────┘ │ │ │ │ │ │ │ ▼ │ │ │ ┌─────────────────┐ │ │ │ │ NavigationType │ │ │ │ │ (Enum) │ │ │ │ └─────────────────┘ │ │ │ └─────────────────────────────────────────────────────────────┘

📋 Requirements

iOS 16.0+
Swift 5.10+
Xcode 15.0+

Get Started

🚀 NavigationKit