Skip to content

Latest commit

 

History

History
203 lines (155 loc) · 6.1 KB

README.md

File metadata and controls

203 lines (155 loc) · 6.1 KB
Raw

Nivelir

Build Status Cocoapods Carthage compatible SPM compatible Platforms Xcode Swift License

Nivelir is a DSL for navigation in iOS and tvOS apps with a simplified, chainable, and compile time safe syntax.

Contents

Requirements

  • iOS 13.0+ / tvOS 13.0+
  • Xcode 14.0+
  • Swift 5.7+

Installation

Swift Package Manager

The Swift Package Manager is a tool for managing the distribution of Swift code. It’s integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies.

To integrate Nivelir into your Xcode project using Swift Package Manager, add the following as a dependency to your Package.swift:

.package(url: "https://github.com/hhru/Nivelir.git", from: "1.9.2")

Then specify "Nivelir" as a dependency of the Target in which you wish to use Nivelir.

Here's an example Package.swift:

// swift-tools-version:5.7
import PackageDescription

let package = Package(
    name: "MyPackage",
    products: [
        .library(name: "MyPackage", targets: ["MyPackage"])
    ],
    dependencies: [
        .package(url: "https://github.com/hhru/Nivelir.git", from: "1.9.2")
    ],
    targets: [
        .target(name: "MyPackage", dependencies: ["Nivelir"])
    ]
)

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate Nivelir into your Xcode project using Carthage, specify it in your Cartfile:

github "hhru/Nivelir" ~> 1.9.2

Finally run carthage update to build the framework and drag the built Nivelir.framework into your Xcode project.

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

To integrate Nivelir into your Xcode project using CocoaPods, specify it in your Podfile:

platform :ios, '13.0'
use_frameworks!

target '<Your Target Name>' do
    pod 'Nivelir', '~> 1.9.2'
end

Finally run the following command:

$ pod install

Usage

API Documentation

Quick Start

Let's implement a simple view controller that can set the background color:

class SomeViewController: UIViewController {

    let color: UIColor

    init(color: UIColor) {
        self.color = color

        super.init(nibName: nil, bundle: nil)
    }

    required init?(coder: NSCoder) {
        fatalError("init(coder:) has not been implemented")
    }

    override func viewDidLoad() {
        super.viewDidLoad()

        view.backgroundColor = color
    }
}

Next, we need to implement a builder that creates our controller:

struct SomeScreen: Screen {

    let color: UIColor

    func build(navigator: ScreenNavigator) -> UIViewController {
        SomeViewController(color: color)
    }
}

Now we can use this screen for navigation:

let navigator = ScreenNavigator()

navigator.navigate { route in
    route
        .top(.stack)
        .popToRoot()
        .push(SomeScreen(color: .red))
        .push(SomeScreen(color: .green)) { route in
            route.present(SomeScreen(color: .blue))
        }
}

This navigation performs the following steps:

  • Search for the topmost container of the stack (UINavigationController)
  • Resetting its stack to the first screen
  • Adding a red screen to the stack
  • Adding a green screen to the stack
  • Presenting a blue screen on the green screen modally

Cheat sheets

Learn the most common use cases for Nivelir. See article in API documentation.

Example App

Example app is a simple iOS and tvOS app that demonstrates how Nivelir works in practice. It's also a good place to start playing with the framework.

To install it, run these commands in a terminal:

$ git clone https://github.com/hhru/Nivelir.git
$ cd Nivelir/Example
$ pod install
$ open NivelirExample.xcworkspace

Articles and Videos

Articles

Videos

Communication

  • If you need help, open an issue.
  • If you found a bug, open an issue.
  • If you have a feature request, open an issue.
  • If you want to contribute, submit a pull request.

📬 You can also write to us in telegram, we will help you: https://t.me/hh_tech

License

Nivelir is available under the MIT license. See the LICENSE file for more info.