Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hhru/nivelir
A Swift DSL for navigation in iOS and tvOS apps with a simplified, chainable, and compile time safe syntax
https://github.com/hhru/nivelir
carthage cocoapods dsl ios navigation router routing spm swift tvos xcode
Last synced: 7 days ago
JSON representation
A Swift DSL for navigation in iOS and tvOS apps with a simplified, chainable, and compile time safe syntax
- Host: GitHub
- URL: https://github.com/hhru/nivelir
- Owner: hhru
- License: mit
- Created: 2021-03-08T11:58:35.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T08:05:08.000Z (2 months ago)
- Last Synced: 2024-10-29T09:19:28.980Z (2 months ago)
- Topics: carthage, cocoapods, dsl, ios, navigation, router, routing, spm, swift, tvos, xcode
- Language: Swift
- Homepage:
- Size: 17.1 MB
- Stars: 251
- Watchers: 25
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nivelir
[](https://github.com/hhru/Nivelir/actions)
[](http://cocoapods.org/pods/Nivelir)
[](https://github.com/Carthage/Carthage)
[](https://swift.org/package-manager/)
[](https://developer.apple.com/discover/)
[](https://developer.apple.com/xcode)
[](https://swift.org)
[](https://opensource.org/licenses/MIT)
Nivelir is a DSL for navigation in iOS and tvOS apps with a simplified, chainable, and compile time safe syntax.
## Contents
- [Requirements](#requirements)
- [Installation](#installation)
- [Swift Package Manager](#swift-package-manager)
- [Carthage](#carthage)
- [CocoaPods](#cocoapods)
- [Usage](#usage)
- [Quick Start](#quick-start)
- [Example App](#example-app)
- [Articles and Videos](#articles-and-videos)
- [Communication](#communication)
- [License](#license)
## Requirements
- iOS 13.0+ / tvOS 13.0+
- Xcode 14.0+
- Swift 5.7+
## Installation
### Swift Package Manager
The [Swift Package Manager](https://swift.org/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`:
``` swift
.package(url: "https://github.com/hhru/Nivelir.git", from: "1.9.4")
```
Then specify `"Nivelir"` as a dependency of the Target in which you wish to use Nivelir.
Here's an example `Package.swift`:
``` 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.4")
],
targets: [
.target(name: "MyPackage", dependencies: ["Nivelir"])
]
)
```
### Carthage
[Carthage](https://github.com/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:
``` sh
$ brew update
$ brew install carthage
```
To integrate Nivelir into your Xcode project using Carthage, specify it in your `Cartfile`:
``` ogdl
github "hhru/Nivelir" ~> 1.9.4
```
Finally run `carthage update` to build the framework and drag the built `Nivelir.framework` into your Xcode project.
### CocoaPods
[CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command:
``` bash
$ gem install cocoapods
```
To integrate Nivelir into your Xcode project using [CocoaPods](http://cocoapods.org), specify it in your `Podfile`:
``` ruby
platform :ios, '13.0'
use_frameworks!
target '' do
pod 'Nivelir', '~> 1.9.4'
end
```
Finally run the following command:
``` bash
$ pod install
```
## Usage
[API Documentation](http://tech.hh.ru/Nivelir/documentation/nivelir)
### Quick Start
Let's implement a simple view controller that can set the background color:
``` swift
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:
``` swift
struct SomeScreen: Screen {
let color: UIColor
func build(navigator: ScreenNavigator) -> UIViewController {
SomeViewController(color: color)
}
}
```
Now we can use this screen for navigation:
``` swift
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](http://tech.hh.ru/Nivelir/documentation/nivelir/cheatsheet).
### Example App
[Example app](Example) 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:
``` sh
$ git clone https://github.com/hhru/Nivelir.git
$ cd Nivelir/Example
$ pod install
$ open NivelirExample.xcworkspace
```
## Articles and Videos
### Articles
- [EN] [Nivelir: a convenient DSL for navigation](https://medium.com/hh-ru/nivelir-b6c550332971)
- [RU] [Nivelir: Удобный DSL для навигации](https://habr.com/ru/company/hh/blog/572488/)
### Videos
- [RU] [Обзор решений для навигации в iOS. Предпосылки Nivelir](https://youtu.be/FjAwpocB6rA)
- [RU] [Гибкая навигации в iOS. Nivelir](https://youtu.be/GcPTi8-WIn8)
## 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](LICENSE) file for more info.