Swiftpack.co - Package - clmntcrl/swidux-router

SwiduxRouter

Router driven by Swidux store.

Usage

Declare your routes:

extension Route {
    static let home = Route(type: HomeViewController.self)
    static let product: (Id<Product>) -> Route = { Route(type: HomeViewController.self, routeParam: $0) }
    // ...
}

Prepare your Swidux store defining initial route:

struct AppState {
    var root = RootDescriptor(initialRoute: .home)
    // ...
}

let store = Store(
    initialState: AppState(),
    reducer: .combine(reducers: [
        routeReducer.lift(\.root),
        // ...
    ])
)

Make your view controllers Routable or ParametricRoutable if it depends on parameters (for exemple a product page depend on a product id).

class HomeViewController: Routable {/* ... */}

class ProductViewController: ParametricRoutable {
    var routeParam: Id<Product>!
    // ...
}

Init your Router and add it to the view controller hierarchy:

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
    let window = UIWindow()

    func application(
        _ application: UIApplication,
        didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
    ) -> Bool {
        window.rootViewController = Router(
            store: store,
            keyPath: \.root
        )
        window.makeKeyAndVisible()
        return true
    }
}

In order to route to new screens use store.dispatch with one of the following route action:

enum RouteAction: Action {
    case present(Route)
    case push(Route)
    case back
    case backToRoot
    case backTo(Route)
    case reset(RootDescriptor)
}

Known issues

  • Missing support for UITabBarController

Installation

Carthage

Add the following dependency to your Cartfile:

github "clmntcrl/swidux-router" ~> 0.2

CocoaPods

Add the following pod to your Podfile:

pod 'SwiduxRouter', '~> 0.2'

SwiftPM

Add the package as dependency in your Package.swift:

dependencies: [
    .package(url: "https://github.com/clmntcrl/swidux-router.git", from: "0.2.0"),
]

Create a xcode.xcconfig file, with the following content:

SUPPORTED_PLATFORMS = iphoneos iphonesimulator
IPHONEOS_DEPLOYMENT_TARGET = 10.0

Generate .xcodeproj:

swift package generate-xcodeproj --xcconfig-overrides xcode.xcconfig

License

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

Github

link
Stars: 0
Help us keep the lights on

Dependencies

Releases

0.2.0 - Feb 1, 2019

  • Use Swidux 1.0.0 and its new middleware architecture
  • Support package managers:
    • Carthage
    • CocoaPods
    • SwiftPM

0.1.5 - Nov 30, 2018

Fix issue where nothing happen when presented route dispatch reset, backToRoot or backTo action

0.1.4 - Nov 28, 2018

  • Remove RouteAction associated property name.
  • Rename RootDescriptor presenting property presented to be sync with UIKit naming (see UIViewControllerTransitioningDelegate)

0.1.3 - Nov 27, 2018

Add support for present(route:) action.

Breaking change: Initial route is now defined in RootDescriptor which contains route stack (see README and Playground for more details)

0.1.2 - Nov 10, 2018

Define initial route in Swidux store initial state.