diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 00000000..8f6a65ec --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,77 @@ +name: CI + +on: + push: + branches: [master, main, "feature/**", "release/**"] + pull_request: + branches: [master, main] + +concurrency: + group: ci-${{ github.ref }} + cancel-in-progress: true + +jobs: + build-test: + name: Build & Test (iOS Simulator) + runs-on: macos-15 + steps: + - uses: actions/checkout@v4 + + - name: Select latest Xcode + uses: maxim-lobanov/setup-xcode@v1 + with: + xcode-version: latest-stable + + - name: Show toolchain + run: | + xcodebuild -version + swift --version + + - name: Resolve packages + run: swift package resolve + + - name: Build (iOS Simulator) + run: Scripts/build.sh + + - name: Build (tvOS) + # Generic tvOS build (no simulator runtime required) so tvOS support — advertised in the + # podspec/README — is actually compiled in CI. + run: | + xcodebuild build \ + -scheme XCoordinator \ + -destination 'generic/platform=tvOS' \ + -skipPackagePluginValidation \ + CODE_SIGNING_ALLOWED=NO + + - name: Test + run: Scripts/test.sh + + pod-lint: + name: CocoaPods lint + runs-on: macos-15 + steps: + - uses: actions/checkout@v4 + + - name: Select latest Xcode + uses: maxim-lobanov/setup-xcode@v1 + with: + xcode-version: latest-stable + + - name: Lint podspec + # iOS only: recent Xcode does not ship the tvOS simulator runtime, and the rest + # of CI (build/test/docs) is iOS-only as well. + run: pod lib lint --allow-warnings --fail-fast --platforms=ios + + docs: + name: DocC build + runs-on: macos-15 + steps: + - uses: actions/checkout@v4 + + - name: Select latest Xcode + uses: maxim-lobanov/setup-xcode@v1 + with: + xcode-version: latest-stable + + - name: Build documentation + run: Scripts/docs.sh diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 00000000..cf353e37 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,45 @@ +name: Publish documentation + +on: + push: + tags: ["*"] + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: pages + cancel-in-progress: true + +jobs: + build: + runs-on: macos-15 + steps: + - uses: actions/checkout@v4 + + - name: Select latest Xcode + uses: maxim-lobanov/setup-xcode@v1 + with: + xcode-version: latest-stable + + - name: Build documentation + run: Scripts/docs.sh XCoordinator + + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: ./Documentation + + deploy: + needs: build + runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/.gitignore b/.gitignore index eeceeef6..5c59d728 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,8 @@ -# Mac OS X -*.DS_Store +# macOS +**/.DS_Store # Xcode -.build +.build/ *.pbxuser *.mode1v3 *.mode2v3 @@ -12,17 +12,21 @@ project.xcworkspace/ xcuserdata/ Pods/*.xcodeproj/xcuserdata/ +# Swift Package Manager +/.swiftpm/xcode/xcuserdata/ +/.swiftpm/xcode/package.xcworkspace/xcuserdata/ +/.swiftpm/configuration/ +Package.resolved + # Generated files *.o *.pyc -# Docs -docs/docsets/XCoordinator.tgz -docs/undocumented.json +# Documentation outputs +/Documentation/ +*.doccarchive/ # Backup files *~.nib \#*# .#* - -.swiftpm diff --git a/.jazzy.yaml b/.jazzy.yaml deleted file mode 100644 index a3a42f23..00000000 --- a/.jazzy.yaml +++ /dev/null @@ -1,8 +0,0 @@ -author: "Stefan Kofler & Paul Kraft" -author_url: https://quickbirdstudios.com -podspec: XCoordinator.podspec -docset_icon: Images/logo-single.png -github_url: https://github.com/quickbirdstudios/XCoordinator -hide_documentation_coverage: true -theme: fullwidth -clean: true diff --git a/.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata b/.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata new file mode 100644 index 00000000..919434a6 --- /dev/null +++ b/.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata @@ -0,0 +1,7 @@ + + + + + diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 3f4cf7c7..00000000 --- a/.travis.yml +++ /dev/null @@ -1,12 +0,0 @@ -language: objective-c -osx_image: xcode11 - -install: -# - gem update -# - gem install jazzy -# - brew update -# - brew install sourcekitten -script: - - cd scripts - - ./build.sh -# - ./check_docs.sh diff --git a/Package.resolved b/Package.resolved deleted file mode 100644 index 4c541df3..00000000 --- a/Package.resolved +++ /dev/null @@ -1,16 +0,0 @@ -{ - "object": { - "pins": [ - { - "package": "RxSwift", - "repositoryURL": "https://github.com/ReactiveX/RxSwift.git", - "state": { - "branch": null, - "revision": "7c17a6ccca06b5c107cfa4284e634562ddaf5951", - "version": "6.2.0" - } - } - ] - }, - "version": 1 -} diff --git a/Package.swift b/Package.swift index 9457fbd5..5d7fe3a9 100644 --- a/Package.swift +++ b/Package.swift @@ -1,42 +1,28 @@ -// swift-tools-version:5.1 -// The swift-tools-version declares the minimum version of Swift required to build this package. +// swift-tools-version:5.9 import PackageDescription let package = Package( name: "XCoordinator", - platforms: [.iOS(.v9), .tvOS(.v9)], + platforms: [.iOS(.v16), .tvOS(.v16)], products: [ - // Products define the executables and libraries produced by a package, and make them visible to other packages. .library( name: "XCoordinator", targets: ["XCoordinator"]), .library( name: "XCoordinatorRx", targets: ["XCoordinatorRx"]), - .library( - name: "XCoordinatorCombine", - targets: ["XCoordinatorCombine"]), ], dependencies: [ - // Dependencies declare other packages that this package depends on. - // .package(url: /* package url */, from: "1.0.0"), - .package(url: "https://github.com/ReactiveX/RxSwift.git", from: "6.0.0"), + .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.3.0"), + .package(url: "https://github.com/ReactiveX/RxSwift.git", from: "6.5.0"), ], targets: [ - // Targets are the basic building blocks of a package. A target can define a module or a test suite. - // Targets can depend on other targets in this package, and on products in packages which this package depends on. .target( name: "XCoordinator", dependencies: []), .target( name: "XCoordinatorRx", dependencies: ["XCoordinator", "RxSwift"]), - .target( - name: "XCoordinatorCombine", - dependencies: ["XCoordinator"]), - .testTarget( - name: "XCoordinatorTests", - dependencies: ["XCoordinator", "XCoordinatorRx"]), ] ) diff --git a/README.md b/README.md index 315ee43b..e8bc74d2 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,62 @@

- + XCoordinator logo

-# [![Build Status](https://travis-ci.com/quickbirdstudios/XCoordinator.svg?branch=master)](https://travis-ci.com/quickbirdstudios/XCoordinator) [![CocoaPods Compatible](https://img.shields.io/cocoapods/p/XCoordinator)](https://cocoapods.org/pods/XCoordinator) [![Carthage Compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage) [![Documentation](https://img.shields.io/badge/documentation-100%25-brightgreen)](https://quickbirdstudios.github.io/XCoordinator) [![Platform](https://img.shields.io/badge/platform-iOS-lightgrey.svg)](https://github.com/quickbirdstudios/XCoordinator) [![License](https://img.shields.io/cocoapods/l/XCoordinator.svg)](https://github.com/quickbirdstudios/XCoordinator/blob/master/LICENSE) +# XCoordinator -⚠️ We have recently released XCoordinator 2.0. Make sure to read [this section](#when-to-use-which-router-abstraction) before migrating. In general, please replace all `AnyRouter` by either `UnownedRouter` (in viewControllers, viewModels or references to parent coordinators) or `StrongRouter` in your `AppDelegate` or for references to child coordinators. In addition to that, the rootViewController is now injected into the initializer instead of being created in the `Coordinator.generateRootViewController` method. +[![CI](https://github.com/quickbirdstudios/XCoordinator/actions/workflows/ci.yml/badge.svg)](https://github.com/quickbirdstudios/XCoordinator/actions/workflows/ci.yml) +[![Swift](https://img.shields.io/badge/Swift-5.9-orange.svg)](https://swift.org) +[![Platforms](https://img.shields.io/badge/platforms-iOS%2016%20%7C%20tvOS%2016-lightgrey.svg)](https://github.com/quickbirdstudios/XCoordinator) +[![SwiftPM](https://img.shields.io/badge/SPM-compatible-brightgreen.svg)](https://swift.org/package-manager/) +[![CocoaPods](https://img.shields.io/cocoapods/v/XCoordinator)](https://cocoapods.org/pods/XCoordinator) +[![License](https://img.shields.io/cocoapods/l/XCoordinator.svg)](LICENSE) -“How does an app transition from one view controller to another?”. -This question is common and puzzling regarding iOS development. There are many answers, as every architecture has different implementation variations. Some do it from within the implementation of a view controller, while some use a router/coordinator, an object connecting view models. +**Type-safe, enum-driven navigation for UIKit and SwiftUI based on the Coordinator pattern.** -To better answer the question, we are building **XCoordinator**, a navigation framework based on the **Coordinator** pattern. -It's especially useful for implementing MVVM-C, Model-View-ViewModel-Coordinator: +XCoordinator decouples navigation from view controllers and view models: you describe a flow as a `Route` enum, and a `Coordinator` decides which `Transition` to perform for each route. The result is reusable views, view models without navigation logic, and a single place to evolve the flow of your app. -

- -

+- 📚 **API reference** — [hosted DocC documentation](https://quickbirdstudios.github.io/XCoordinator/) +- 🧪 **Example app** — [XCoordinator-Example](https://github.com/quickbirdstudios/XCoordinator-Example) — a complete MVVM-C app using XCoordinator +- 🚀 **What's new in 3.0** — see [Migrating from 2.x to 3.0](#-migrating-from-2x-to-30) below + +## Table of contents -## 🏃‍♂️Getting started +- [Why XCoordinator](#-why-xcoordinator) +- [Getting started](#%EF%B8%8F-getting-started) +- [SwiftUI interop](#-swiftui-interop) +- [Choosing a router reference](#-choosing-a-router-reference) +- [Custom transitions](#-custom-transitions) +- [Deep linking](#-deep-linking) +- [RedirectionRouter](#-redirectionrouter) +- [Combine and RxSwift](#-combine-and-rxswift) +- [Migrating from 2.x to 3.0](#-migrating-from-2x-to-30) +- [Installation](#-installation) +- [Requirements](#-requirements) +- [Contributing](#%EF%B8%8F-contributing) -Create an enum with all of the navigation paths for a particular flow, i.e. a group of closely connected scenes. (It is up to you when to create a `Route/Coordinator`. As **our rule of thumb**, create a new `Route/Coordinator` whenever a new root view controller, e.g. a new `navigation controller` or a `tab bar controller`, is needed.). +## 🤔 Why XCoordinator + +- **Type-safe routes** — enums give you autocompletion and compile-time errors instead of stringly-typed paths. +- **One place for navigation** — view models trigger routes; the coordinator decides what each route does. +- **UIKit and SwiftUI** — a single coordinator can mix `UIViewController` flows with SwiftUI views via `RoutingController`, `WrappedRouter`, and `@Routing`. +- **Reusable** — coordinators, transitions, and animations compose; the same view model works inside different flows. +- **Custom transitions and deep linking** built in — interactive transitions, presentation animations, and route chains across coordinator boundaries. + +

+ MVVM-C diagram showing how Coordinator connects View, ViewModel, and Model +
How Coordinator fits into MVVM +

-Whereas the `Route` describes which routes can be triggered in a flow, the `Coordinator` is responsible for the preparation of transitions based on routes being triggered. We could, therefore, prepare multiple coordinators for the same route, which differ in which transitions are executed for each route. +## 🏃‍♂️ Getting started -In the following example, we create the `UserListRoute` enum to define triggers of a flow of our application. `UserListRoute` offers routes to open the home screen, display a list of users, to open a specific user and to log out. The `UserListCoordinator` is implemented to prepare transitions for the triggered routes. When a `UserListCoordinator` is shown, it triggers the `.home` route to display a `HomeViewController`. +Define a `Route` enum and a `Coordinator` that prepares a transition for each case. Since 3.0 you can +describe transitions with the **transition builder** ✨ — opt in by annotating your override with +`@TransitionBuilder`: ```swift enum UserListRoute: Route { case home - case users case user(String) - case registerUsersPeek(from: Container) case logout } @@ -38,65 +65,68 @@ class UserListCoordinator: NavigationCoordinator { super.init(initialRoute: .home) } + @TransitionBuilder override func prepareTransition(for route: UserListRoute) -> NavigationTransition { switch route { case .home: - let viewController = HomeViewController.instantiateFromNib() - let viewModel = HomeViewModelImpl(router: unownedRouter) - viewController.bind(to: viewModel) - return .push(viewController) - case .users: - let viewController = UsersViewController.instantiateFromNib() - let viewModel = UsersViewModelImpl(router: unownedRouter) - viewController.bind(to: viewModel) - return .push(viewController, animation: .interactiveFade) - case .user(let username): - let coordinator = UserCoordinator(user: username) - return .present(coordinator, animation: .default) - case .registerUsersPeek(let source): - return registerPeek(for: source, route: .users) + Transition.push(HomeViewController()) + case .user(let name): + Transition.present(UserCoordinator(user: name), animation: .default) case .logout: - return .dismiss() + Transition.dismiss() } } } ``` -Routes are triggered from within Coordinators or ViewModels. In the following, we describe how to trigger routes from within a ViewModel. The router of the current flow is injected into the ViewModel. +> ✨ **New in 3.0 — the transition builder.** A `@resultBuilder` DSL lets you compose transitions +> declaratively by listing the `Transition.…` factories (`.push`, `.present`, `.select`, …) — list +> several in one block to chain them (like `.multiple`). It's opt-in and additive. -```swift -class HomeViewModel { - let router: UnownedRouter +
+Classic style (still supported, non-breaking) - init(router: UnownedRouter) { - self.router = router - } +The original style — a plain `prepareTransition(for:)` returning `Transition.…` factories — keeps working +exactly as before. Just omit the `@TransitionBuilder` annotation: - /* ... */ - - func usersButtonPressed() { - router.trigger(.users) +```swift +class UserListCoordinator: NavigationCoordinator { + override func prepareTransition(for route: UserListRoute) -> NavigationTransition { + switch route { + case .home: .push(HomeViewController()) + case .user(let name): .present(UserCoordinator(user: name), animation: .default) + case .logout: .dismiss() + } } } ``` -### 🏗 Organizing an app's structure with XCoordinator +The builder is a modern convenience, not a requirement — you opt into it per override by adding the attribute. +
-In general, an app's structure is defined by nesting coordinators and view controllers. You can transition (i.e. `push`, `present`, `pop`, `dismiss`) to a different coordinator whenever your app changes to a different flow. Within a flow, we transition between viewControllers. +Trigger routes from a view model that holds a typed router reference: -Example: In `UserListCoordinator.prepareTransition(for:)` we change from the `UserListRoute` to the `UserRoute` whenever the `UserListRoute.user` route is triggered. By dismissing a viewController in `UserListRoute.logout`, we additionally switch back to the previous flow - in this case the `HomeRoute`. +```swift +class HomeViewModel { + unowned let router: any Router -To achieve this behavior, every Coordinator has its own `rootViewController`. This would be a `UINavigationController` in the case of a `NavigationCoordinator`, a `UITabBarController` in the case of a `TabBarCoordinator`, etc. When transitioning to a Coordinator/Router, this `rootViewController` is used as the destination view controller. + init(router: any Router) { + self.router = router + } -### 🏁 Using XCoordinator from App Launch + func userButtonPressed(name: String) { + router.trigger(.user(name)) + } +} +``` -To use coordinators from the launch of the app, make sure to create the app's `window` programmatically in `AppDelegate.swift` (Don't forget to remove `Main Storyboard file base name` from `Info.plist`). Then, set the coordinator as the root of the `window`'s view hierarchy in the `AppDelegate.didFinishLaunching`. Make sure to hold a strong reference to your app's initial coordinator or a `strongRouter` reference. +Bootstrap the initial coordinator from your app delegate or `@main` entry point — hold a strong `any Router` to keep it alive: ```swift @UIApplicationMain class AppDelegate: UIResponder, UIApplicationDelegate { let window: UIWindow! = UIWindow() - let router = AppCoordinator().strongRouter + let router: any Router = AppCoordinator() func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { router.setRoot(for: window) @@ -105,277 +135,219 @@ class AppDelegate: UIResponder, UIApplicationDelegate { } ``` -## 🤸‍♂️ Extras +### How transitions compose -For more advanced use, XCoordinator offers many more customization options. We introduce custom animated transitions and deep linking. Furthermore, extensions for use in reactive programming with RxSwift/Combine and options to split up huge routes are described. +An app's structure is defined by nesting coordinators. Whenever your app changes flow (a new navigation stack, a new tab bar) introduce a new coordinator. Each coordinator owns a `rootViewController` (a `UINavigationController`, `UITabBarController`, etc.) that becomes the destination when another coordinator pushes or presents it. -### 🌗 Custom Transitions +## 🚀 SwiftUI interop -Custom animated transitions define presentation and dismissal animations. You can specify `Animation` objects in `prepareTransition(for:)` in your coordinator for several common transitions, such as `present`, `dismiss`, `push` and `pop`. Specifying no animation (`nil`) results in not overriding previously set animations. Use `Animation.default` to reset previously set animation to the default animations UIKit offers. +XCoordinator integrates with SwiftUI in two directions. -```swift -class UsersCoordinator: NavigationCoordinator { +**Embed a coordinator inside SwiftUI** with `WrappedRouter`. The closure builds the coordinator on first appearance and the instance is retained for the lifetime of the view: - /* ... */ - - override func prepareTransition(for route: UserRoute) -> NavigationTransition { - switch route { - case .user(let name): - let animation = Animation( - presentationAnimation: YourAwesomePresentationTransitionAnimation(), - dismissalAnimation: YourAwesomeDismissalTransitionAnimation() - ) - let viewController = UserViewController.instantiateFromNib() - let viewModel = UserViewModelImpl(name: name, router: unownedRouter) - viewController.bind(to: viewModel) - return .push(viewController, animation: animation) - /* ... */ +```swift +struct ContentView: View { + var body: some View { + WrappedRouter { + UsersCoordinator() } } } ``` -### 🛤 Deep Linking - -Deep Linking can be used to chain different routes together. In contrast to the `.multiple` transition, deep linking can identify routers based on previous transitions (e.g. when pushing or presenting a router), which enables chaining of routes of different types. Keep in mind, that you cannot access higher-level routers anymore once you trigger a route on a lower level of the router hierarchy. +**Push or present a SwiftUI view from a UIKit coordinator** with `RoutingController`, a `UIHostingController` subclass that propagates the current `RoutingContext` into the SwiftUI environment: ```swift -class AppCoordinator: NavigationCoordinator { - - /* ... */ - - override func prepareTransition(for route: AppRoute) -> NavigationTransition { +class UsersCoordinator: NavigationCoordinator { + override func prepareTransition(for route: UserRoute) -> NavigationTransition { switch route { - /* ... */ - case .deep: - return deepLink(AppRoute.login, AppRoute.home, HomeRoute.news, HomeRoute.dismiss) + case .user(let name): + return .push(RoutingController { UserView(name: name) }) } } } ``` -⚠️ XCoordinator does not check at compile-time, whether a deep link can be executed. Rather it uses assertionFailures to inform about incorrect chaining at runtime, when it cannot find an appropriate router for a given route. Keep this in mind when changing the structure of your app. - -### 🚏 RedirectionRouter - -Let's assume, there is a route type called `HugeRoute` with more than 10 routes. To decrease coupling, `HugeRoute` needs to be split up into multiple route types. As you will discover, many routes in `HugeRoute` use transitions dependent on a specific rootViewController, such as `push`, `show`, `pop`, etc. If splitting up routes by introducing a new router/coordinator is not an option, XCoordinator has two solutions for you to solve such a case: `RedirectionRouter` or using multiple coordinators with the same rootViewController ([see this section for more information](#using-multiple-coordinators-with-the-same-rootviewcontroller)). - -A `RedirectionRouter` can be used to map a new route type onto a generalized `ParentRoute`. A `RedirectionRouter` is independent of the `TransitionType` of its parent router. You can use `RedirectionRouter.init(viewController:parent:map:)` or subclassing by overriding `mapToParentRoute(_:)` to create a `RedirectionRouter`. - -The following code example illustrates how a `RedirectionRouter` is initialized and used. +**Trigger routes from inside a SwiftUI view** with `@Routing`: ```swift -class ParentCoordinator: NavigationCoordinator { - /* ... */ - - override func prepareTransition(for route: ParentRoute) -> NavigationTransition { - switch route { - /* ... */ - case .child: - let childCoordinator = ChildCoordinator(parent: unownedRouter) - return .push(childCoordinator) - } - } -} +struct ChildView: View { + @Routing var usersRouter -class ChildCoordinator: RedirectionRouter { - init(parent: UnownedRouter) { - let viewController = UIViewController() - // this viewController is used when performing transitions with the Subcoordinator directly. - super.init(viewController: viewController, parent: parent, map: nil) - } - - /* ... */ - - override func mapToParentRoute(for route: ChildRoute) -> ParentRoute { - // you can map your ChildRoute enum to ParentRoute cases here that will get triggered on the parent router. + var body: some View { + Button("Open") { + usersRouter.trigger(.user("Bob")) + } } } ``` -### 🚏Using multiple coordinators with the same rootViewController - -With XCoordinator 2.0, we introduce the option to use different coordinators with the same rootViewController. -Since you can specify the rootViewController in the initializer of a new coordinator, you can specify an existing coordinator's rootViewController as in the following: +**Drive SwiftUI state changes from `prepareTransition(for:)`** without performing a UIKit transition — use `Transition.withAnimation` or `Transition.withTransaction`: ```swift -class FirstCoordinator: NavigationCoordinator { - /* ... */ - - override func prepareTransition(for route: FirstRoute) -> NavigationTransition { +class HomeCoordinator: TabBarCoordinator { + @Binding var selection: HomeTab + + override func prepareTransition(for route: HomeRoute) -> TabBarTransition { switch route { - case .secondCoordinator: - let secondCoordinator = SecondCoordinator(rootViewController: self.rootViewController) - addChild(secondCoordinator) - return .none() - // you could also trigger a specific initial route at this point, - // such as `.trigger(SecondRoute.initial, on: secondCoordinator)` + case .select(let tab): + return .withAnimation { selection = tab } } } } ``` -We suggest to not use initial routes in the initializers of sibling coordinators, but instead using the transition option in the `FirstCoordinator` instead. +For declarative triggering, `triggerOnAppear`, `triggerOnChange(of:)`, and `trigger(when:)` view modifiers fire routes through `@Routing` automatically. -⚠️ If you perform transitions involving a sibling coordinator directly (e.g. pushing a sibling coordinator without overriding its `viewController` property), your app will most likely crash. +## 🧭 Choosing a router reference -### 🚀 RxSwift/Combine extensions - -Reactive programming can be very useful to keep the state of view and model consistent in a MVVM architecture. Instead of relying on the completion handler of the `trigger` method available in any `Router`, you can also use our RxSwift-extension. In the example application, we use Actions (from the [Action](https://github.com/RxSwiftCommunity/Action) framework) to trigger routes on certain UI events - e.g. to trigger `LoginRoute.home` in `LoginViewModel`, when the login button is tapped. +Since 3.0, type erasure is provided by Swift's parameterized existential `any Router`. The previously dedicated `AnyRouter`, `StrongRouter`, `UnownedRouter`, and `WeakRouter` types are gone. Pick the ARC qualifier that matches the relationship: ```swift -class LoginViewModelImpl: LoginViewModel, LoginViewModelInput, LoginViewModelOutput { - - private let router: UnownedRouter +let strongRouter: any Router = ... // own the coordinator +weak var weakRouter: (any Router)? = ... // sibling/parent reference +unowned let unownedRouter: any Router = ... // child holding parent +``` - private lazy var loginAction = CocoaAction { [unowned self] in - return self.router.rx.trigger(.home) - } +- **strong** — the app delegate or whatever object owns the coordinator's lifetime; also used to hold child coordinators. +- **weak** — view models or view controllers referring to a sibling or parent coordinator. +- **unowned** — same use case as weak when the holder is guaranteed not to outlive the coordinator. - /* ... */ -} +## 🌗 Custom transitions -``` - -In addition to the above-mentioned approach, the reactive `trigger` extension can also be used to sequence different transitions by using the `flatMap` operator, as can be seen in the following: +Pass a custom `Animation` to common transitions (`push`, `pop`, `present`, `dismiss`). Pass `nil` to keep the previously configured animation; pass `Animation.default` to reset to UIKit defaults. ```swift -let doneWithBothTransitions = - router.rx.trigger(.home) - .flatMap { [unowned self] in self.router.rx.trigger(.news) } - .map { true } - .startWith(false) +override func prepareTransition(for route: UserRoute) -> NavigationTransition { + switch route { + case .user(let name): + let animation = Animation( + presentationAnimation: YourAwesomePresentationTransitionAnimation(), + dismissalAnimation: YourAwesomeDismissalTransitionAnimation() + ) + return .push(UserViewController(name: name), animation: animation) + } +} ``` -When using `XCoordinator` with the `Combine` extensions, you can use `router.publishers.trigger` instead of `router.rx.trigger`. +For interactive transitions driven by gesture recognizers, see `BaseCoordinator.registerInteractiveTransition(for:triggeredBy:handler:completion:)` and its progress-based overload. -## 📚 Documentation & Example app +## 🛤 Deep linking -To get more information about XCoordinator, check out the [documentation](https://quickbirdeng.github.io/XCoordinator/). -Additionally, this [repository](https://github.com/quickbirdstudios/XCoordinator-Example) serves as an example project using a MVVM architecture with XCoordinator. +> [!IMPORTANT] +> Deep links are not validated at compile time. If a router for one of the chained route types cannot be located at runtime, XCoordinator calls `assertionFailure`. Be careful when reshaping your coordinator hierarchy. -For a MVC example app, have a look at [some presentations](https://github.com/quickbirdstudios/XCoordinator-Talks) we did about the Coordinator pattern and XCoordinator. +Chain routes across coordinator boundaries using `deepLink(_:_:)`. The deep link walks the coordinator tree, switching to whichever router can handle the next route type: -## 👨‍✈️ Why coordinators - -* **Separation of responsibilities** with the coordinator being the only component knowing anything related to the flow of your application. -* **Reusable Views and ViewModels** because they do not contain any navigation logic. -* **Less coupling between components** - -* **Changeable navigation**: Each coordinator is only responsible for one component and does not need to make assumptions about its parent. It can therefore be placed wherever we want to. +```swift +override func prepareTransition(for route: AppRoute) -> NavigationTransition { + switch route { + case .deep: + return deepLink(AppRoute.login, AppRoute.home, HomeRoute.news, HomeRoute.dismiss) + } +} +``` -> [The Coordinator](http://khanlou.com/2015/01/the-coordinator/) by **Soroush Khanlou** +## 🚏 RedirectionRouter +When a route enum has grown too large but you cannot introduce a new root view controller, `RedirectionRouter` lets you split a child route type onto a parent route type without owning its own transition type: -## ⁉️ Why XCoordinator +```swift +class ChildCoordinator: RedirectionRouter { + init(parent: any Router) { + super.init(viewController: UIViewController(), parent: parent, map: nil) + } -* Actual **navigation code is already written** and abstracted away. -* Clear **separation of concerns**: - - Coordinator: Coordinates routing of a set of routes. - - Route: Describes navigation path. - - Transition: Describe transition type and animation to new view. -* **Reuse** coordinators, routers and transitions in different combinations. -* Full support for **custom transitions/animations**. -* Support for **embedding child views** / container views. -* Generic `BasicCoordinator` classes suitable for many use cases and therefore **less** need to write your **own coordinators**. -* Full **support** for your **own coordinator classes** conforming to our Coordinator protocol - - You can also start with one of the following types to get a head start: `NavigationCoordinator`, `ViewCoordinator`, `TabBarCoordinator` and more. -* Generic AnyRouter type erasure class encapsulates all types of coordinators and routers supporting the same set of routes. Therefore you can **easily replace coordinators**. -* Use of enum for routes gives you **autocompletion** and **type safety** to perform only transition to routes supported by the coordinator. + override func mapToParentRoute(for route: ChildRoute) -> ParentRoute { + // map ChildRoute cases onto ParentRoute cases + } +} +``` -## 🔩 Components +Alternatively, two sibling coordinators can share the same `rootViewController` by passing it into the second coordinator's initializer. -### 🎢 Route +## 🔀 Combine and RxSwift -Describes possible navigation paths within a flow, a collection of closely related scenes. +The Combine extensions are built into the main `XCoordinator` module. Use `router.publishers.trigger(_:)` to obtain a publisher for a triggered route. The publisher is **lazy** — the transition is performed when you subscribe, not when the publisher is created: -### 👨‍✈️ Coordinator / Router +```swift +router.publishers.trigger(.home) + .sink { /* transition finished */ } +``` -An object loading views and creating viewModels based on triggered routes. A Coordinator creates and performs transitions to these scenes based on the data transferred via the route. In contrast to the coordinator, a router can be seen as an abstraction from that concept limited to triggering routes. Often, a Router is used to abstract from a specific coordinator in ViewModels. +For RxSwift, add the `XCoordinatorRx` product. The `router.rx.trigger(_:)` accessor returns an `Observable`: -#### When to use which Router abstraction +```swift +router.rx.trigger(.home) + .flatMap { [unowned self] in self.router.rx.trigger(.news) } +``` -You can create different router abstractions using the `unownedRouter`, `weakRouter` or `strongRouter` properties of your `Coordinator`. -You can decide between the following router abstractions of your coordinator: +## ⬆️ Migrating from 2.x to 3.0 -- **StrongRouter** holds a strong reference to the original coordinator. You can use this to hold child coordinators or to specify a certain router in the `AppDelegate`. -- **WeakRouter** holds a weak reference to the original coordinator. You can use this to hold a coordinator in a viewController or viewModel. It can also be used to keep a reference to a sibling or parent coordinator. -- **UnownedRouter** holds an unowned reference to the original coordinator. You can use this to hold a coordinator in a viewController or viewModel. It can also be used to keep a reference to a sibling or parent coordinator. +3.0 removes the type-erased router/coordinator wrappers, replaces the `TransitionPerformer`/`TransitionProtocol` layer with the single generic `Transition`, and folds Combine into the main module. Most of the migration is mechanical: -If you want to know more about the differences on how references can be held, have a look [here](https://docs.swift.org/swift-book/LanguageGuide/AutomaticReferenceCounting.html). +| 2.x | 3.0 | +| --- | --- | +| `AnyRouter` | `any Router` | +| `StrongRouter` | `any Router` | +| `WeakRouter` | `weak var router: (any Router)?` | +| `UnownedRouter` | `unowned let router: any Router` | +| `WeakErased` / `UnownedErased` | use `weak`/`unowned` on an `any Router` directly | +| `coordinator.unownedRouter` / `coordinator.weakRouter` | pass `self` directly or capture explicitly with `unowned`/`weak` | +| `AnyCoordinator<…>` / `coordinator.anyCoordinator` | use the coordinator directly, or `any Router` where erasure is needed | +| `TransitionPerformer`, `TransitionProtocol`, `AnyTransitionPerformer` | removed — coordinators now use `Transition` directly | +| `Coordinator.TransitionType` associatedtype | removed — `prepareTransition(for:)` returns `Transition`; specify `RootViewController` instead of `TransitionType` | +| `pod 'XCoordinator/Combine'` | the Combine extensions are bundled into `XCoordinator` | -### 🌗 Transition +### Other breaking changes -Transitions describe the navigation from one view to another. Transitions are available based on the type of the root view controller in use. Example: Whereas `ViewTransition` only supports basic transitions that every root view controller supports, `NavigationTransition` adds navigation controller specific transitions. +- **Minimum platforms raised to iOS 16 / tvOS 16** (from iOS 9 / tvOS 9), and the package now uses **swift-tools 5.9** (Xcode 15+). +- **Combine publishers are now lazy.** `router.publishers.trigger(_:)` / `triggerPublisher(_:)` previously returned an eager `Future` that fired the transition immediately on creation; they now return a lazy `AnyPublisher` that performs the transition on **subscription**. Make sure you subscribe (e.g. `.sink`) to actually run the navigation. -The available transition types include: - - **present** presents a view controller on top of the view hierarchy - use **presentOnRoot** in case you want to present from the root view controller - - **embed** embeds a view controller into a container view - - **dismiss** dismisses the top most presented view controller - use **dismissToRoot** to call dismiss on the root view controller - - **none** does nothing, may be used to ignore routes or for testing purposes - - **push** pushes a view controller to the navigation stack (only in `NavigationTransition`) - - **pop** pops the top view controller from the navigation stack (only in `NavigationTransition`) - - **popToRoot** pops all the view controllers on the navigation stack except the root view controller (only in `NavigationTransition`) - - XCoordinator additionally supports common transitions for `UITabBarController`, `UISplitViewController` and `UIPageViewController` root view controllers. +The SwiftUI interop layer (`RoutingController`, `WrappedRouter`, `@Routing`, `Transition.withAnimation`, …) is new in 3.0 — see [SwiftUI interop](#-swiftui-interop). ## 🛠 Installation -#### CocoaPods +### Swift Package Manager (recommended) -To integrate XCoordinator into your Xcode project using CocoaPods, add this to your `Podfile`: +Add the package to your `Package.swift`: -```ruby -pod 'XCoordinator', '~> 2.0' +```swift +.package(url: "https://github.com/quickbirdstudios/XCoordinator.git", from: "3.0.0") ``` -To use the RxSwift extensions, add this to your `Podfile`: +Then add the product you need to your target's dependencies — either `XCoordinator` (core + Combine + SwiftUI) or `XCoordinatorRx` (adds RxSwift). -```ruby -pod 'XCoordinator/RxSwift', '~> 2.0' -``` +In Xcode, use **File → Add Package Dependencies** and paste the same URL. -To use the Combine extensions, add this to your `Podfile`: +### CocoaPods ```ruby -pod 'XCoordinator/Combine', '~> 2.0' +pod 'XCoordinator', '~> 3.0' ``` -#### Carthage - -To integrate XCoordinator into your Xcode project using Carthage, add this to your `Cartfile`: +For RxSwift bindings: +```ruby +pod 'XCoordinator/RxSwift', '~> 3.0' ``` -github "quickbirdstudios/XCoordinator" ~> 2.0 -``` - -Then run `carthage update`. - -If this is your first time using Carthage in the project, you'll need to go through some additional steps as explained [over at Carthage](https://github.com/Carthage/Carthage#adding-frameworks-to-an-application). - -#### Swift Package Manager - -See [this WWDC presentation](https://developer.apple.com/videos/play/wwdc2019/408/) about more information how to adopt Swift packages in your app. - -Specify `https://github.com/quickbirdstudios/XCoordinator.git` as the `XCoordinator` package link. -You can then decide between three different frameworks, i.e. `XCoordinator`, `XCoordinatorRx` and `XCoordinatorCombine`. -While `XCoordinator` contains the main framework, you can choose `XCoordinatorRx` or `XCoordinatorCombine` to get `RxSwift` or `Combine` extensions as well. - -#### Manually -If you prefer not to use any of the dependency managers, you can integrate XCoordinator into your project manually, by downloading the source code and placing the files on your project directory. +Combine is bundled into the main pod; no separate subspec is needed. -## 👤 Author -This framework is created with ❤️ by [QuickBird Studios](https://quickbirdstudios.com). +## ✅ Requirements -To get more information on XCoordinator check out [our blog post](https://quickbirdstudios.com/blog/ios-navigation-library-based-on-the-coordinator-pattern/). +- iOS 16 / tvOS 16 +- Swift 5.9 +- Xcode 15 ## ❤️ Contributing -Open an issue if you need help, if you found a bug, or if you want to discuss a feature request. If you feel like having a chat about XCoordinator with the developers and other users, join our [Slack Workspace](https://join.slack.com/t/xcoordinator/shared_invite/enQtNDg4NDAxNTk1ODQ1LTkxYzE3MDM5ZGY1MTVmY2NhNjI0Y2JiYmQ5NTdjZDczZDRjZTg1ZmJlOTZmODYyYzMyYWQ0NzhlNGNkMGIzYjQ). +- Open an [issue](https://github.com/quickbirdstudios/XCoordinator/issues) if you found a bug, want to discuss a feature request, or need help. +- Use [GitHub Discussions](https://github.com/quickbirdstudios/XCoordinator/discussions) for usage questions. +- Open a [pull request](https://github.com/quickbirdstudios/XCoordinator/pulls) if you want to contribute a change — please include tests where applicable. -Open a PR if you want to make changes to XCoordinator. +XCoordinator is created and maintained by [QuickBird Studios](https://quickbirdstudios.com). ## 📃 License -XCoordinator is released under an MIT license. See [License.md](https://github.com/quickbirdstudios/XCoordinator/blob/master/LICENSE) for more information. +XCoordinator is released under the MIT License. See [LICENSE](LICENSE) for more information. diff --git a/Scripts/build.sh b/Scripts/build.sh new file mode 100755 index 00000000..e31baba7 --- /dev/null +++ b/Scripts/build.sh @@ -0,0 +1,14 @@ +#!/bin/sh + +# Builds the XCoordinator package against the iOS Simulator SDK. +# Works on both Apple Silicon and Intel Macs — the toolchain selects the appropriate arch. + +set -e -o pipefail + +cd "$(dirname "$0")/.." + +xcodebuild build \ + -scheme XCoordinator \ + -destination 'generic/platform=iOS Simulator' \ + -skipPackagePluginValidation \ + CODE_SIGNING_ALLOWED=NO diff --git a/Scripts/docs.sh b/Scripts/docs.sh new file mode 100755 index 00000000..09a1e78a --- /dev/null +++ b/Scripts/docs.sh @@ -0,0 +1,47 @@ +#!/bin/sh + +# Generates static-hosting DocC output into ./Documentation. +# +# Builds the DocC archive against the iOS SDK via `xcodebuild docbuild` (the +# package depends on UIKit, so a plain SwiftPM host build fails with +# "no such module 'UIKit'"), then transforms it for static hosting. +# +# Pass an optional hosting base path as the first argument (used when publishing +# to GitHub Pages): +# +# Scripts/docs.sh # local / CI validation build +# Scripts/docs.sh XCoordinator # Pages build served under /XCoordinator + +set -e -o pipefail + +cd "$(dirname "$0")/.." + +DERIVED_DATA=".build/docs-derived-data" + +HOSTING_BASE_PATH_ARG="" +if [ -n "$1" ]; then + HOSTING_BASE_PATH_ARG="--hosting-base-path $1" +fi + +rm -rf "$DERIVED_DATA" + +xcodebuild docbuild \ + -scheme XCoordinator \ + -destination 'generic/platform=iOS' \ + -derivedDataPath "$DERIVED_DATA" \ + ONLY_ACTIVE_ARCH=YES \ + CODE_SIGNING_ALLOWED=NO \ + OTHER_DOCC_FLAGS="--warnings-as-errors" \ + -quiet + +ARCHIVE=$(find "$DERIVED_DATA" -type d -name 'XCoordinator.doccarchive' | head -n 1) +if [ -z "$ARCHIVE" ]; then + echo "error: could not find XCoordinator.doccarchive under $DERIVED_DATA" >&2 + exit 1 +fi + +rm -rf ./Documentation + +"$(xcrun --find docc)" process-archive transform-for-static-hosting "$ARCHIVE" \ + --output-path ./Documentation \ + $HOSTING_BASE_PATH_ARG diff --git a/Scripts/docs_preview.sh b/Scripts/docs_preview.sh new file mode 100755 index 00000000..5d04ad7a --- /dev/null +++ b/Scripts/docs_preview.sh @@ -0,0 +1,36 @@ +#!/bin/sh + +# Previews DocC documentation in a local web server. +# Runs unchanged on Apple Silicon and Intel Macs. + +set -e -o pipefail + +cd "$(dirname "$0")/.." + +echo "1. Building documentation archive for iOS..." +(./Scripts/docs.sh) + +# Locate the generated archive (docs.sh builds into .build/docs-derived-data) +DOCC_ARCHIVE=$(find .build/docs-derived-data -type d -name "XCoordinator.doccarchive" | head -n 1) + +if [ -z "$DOCC_ARCHIVE" ]; then + echo "Error: Could not find the generated XCoordinator.doccarchive artifact." + exit 1 +fi + +echo "2. Transforming archive for local static web hosting..." +STATIC_OUT=".build/Documentation/static" +rm -rf "$STATIC_OUT" + +xcrun docc process-archive transform-for-static-hosting "$DOCC_ARCHIVE" \ + --output-path "$STATIC_OUT" + +DOCC_URL=http://localhost:8000/documentation/xcoordinator + +echo "--------------------------------------------------------" +echo "Documentation server running!" +echo "$DOCC_URL" +echo "--------------------------------------------------------" + +# 3. Serve the interactive documentation site +python3 -m http.server --directory "$STATIC_OUT" 8000 diff --git a/Scripts/test.sh b/Scripts/test.sh new file mode 100755 index 00000000..27249a6c --- /dev/null +++ b/Scripts/test.sh @@ -0,0 +1,38 @@ +#!/bin/sh + +# Runs the XCoordinator tests on an iOS Simulator. +# +# The tests exercise real UIKit view-controller transitions, which only work when a +# UIWindowScene exists — something a bare SwiftPM test bundle does not provide. They +# therefore run through the TestHost application (TestHost/XCoordinatorTestHost.xcodeproj), +# which references this package and hosts the tests in Tests/XCoordinatorTests. +# +# An available iPhone simulator is resolved at runtime so this works across Xcode +# versions (which ship different device names) on both local machines and CI. + +set -e -o pipefail + +cd "$(dirname "$0")/.." + +DEVICE_ID=$(xcrun simctl list devices available -j | python3 -c ' +import json, sys +devices = json.load(sys.stdin)["devices"] +candidates = [ + dev["udid"] + for runtime, devs in devices.items() if "iOS" in runtime + for dev in devs if "iPhone" in dev["name"] +] +print(candidates[0] if candidates else "") +') + +if [ -z "$DEVICE_ID" ]; then + echo "error: no available iPhone simulator found" >&2 + exit 1 +fi + +xcodebuild test \ + -project TestHost/XCoordinatorTestHost.xcodeproj \ + -scheme XCoordinatorTestHost \ + -destination "id=$DEVICE_ID" \ + -skipPackagePluginValidation \ + CODE_SIGNING_ALLOWED=NO diff --git a/Sources/XCoordinator/Animation.swift b/Sources/XCoordinator/Animations/Animation.swift similarity index 100% rename from Sources/XCoordinator/Animation.swift rename to Sources/XCoordinator/Animations/Animation.swift diff --git a/Sources/XCoordinator/GestureRecognizerTarget.swift b/Sources/XCoordinator/Animations/GestureRecognizerTarget.swift similarity index 84% rename from Sources/XCoordinator/GestureRecognizerTarget.swift rename to Sources/XCoordinator/Animations/GestureRecognizerTarget.swift index 69907be7..01c4e2bb 100755 --- a/Sources/XCoordinator/GestureRecognizerTarget.swift +++ b/Sources/XCoordinator/Animations/GestureRecognizerTarget.swift @@ -3,6 +3,7 @@ // XCoordinator // // Created by Paul Kraft on 19.12.18. +// Copyright © 2018 QuickBird Studios. All rights reserved. // import UIKit @@ -23,8 +24,7 @@ internal class Target: GestureRecognizer init(recognizer gestureRecognizer: GestureRecognizer, handler: @escaping (GestureRecognizer) -> Void) { self.handler = handler self.gestureRecognizer = gestureRecognizer - // The method signature "handle(_ gestureRecognizer: UIGestureRecognizer)" is in conflict with validation Apple, use another name : "handleMyGesture" - gestureRecognizer.addTarget(self, action: #selector(handleGesture(of: ))) + gestureRecognizer.addTarget(self, action: #selector(handleGesture)) } // MARK: Target actions @@ -34,4 +34,5 @@ internal class Target: GestureRecognizer guard let recognizer = gestureRecognizer as? GestureRecognizer else { return } handler(recognizer) } + } diff --git a/Sources/XCoordinator/InteractiveTransitionAnimation.swift b/Sources/XCoordinator/Animations/InteractiveTransitionAnimation.swift similarity index 100% rename from Sources/XCoordinator/InteractiveTransitionAnimation.swift rename to Sources/XCoordinator/Animations/InteractiveTransitionAnimation.swift diff --git a/Sources/XCoordinator/InterruptibleTransitionAnimation.swift b/Sources/XCoordinator/Animations/InterruptibleTransitionAnimation.swift similarity index 97% rename from Sources/XCoordinator/InterruptibleTransitionAnimation.swift rename to Sources/XCoordinator/Animations/InterruptibleTransitionAnimation.swift index 4259744d..c5fd5f62 100755 --- a/Sources/XCoordinator/InterruptibleTransitionAnimation.swift +++ b/Sources/XCoordinator/Animations/InterruptibleTransitionAnimation.swift @@ -3,16 +3,15 @@ // XCoordinator // // Created by Paul Kraft on 24.12.18. +// Copyright © 2018 QuickBird Studios. All rights reserved. // import UIKit /// /// Use InterruptibleTransitionAnimation to define interactive transitions based on the -/// [UIViewPropertyAnimator](https://developer.apple.com/documentation/uikit/UIViewPropertyAnimator) -/// APIs introduced in iOS 10. +/// [UIViewPropertyAnimator](https://developer.apple.com/documentation/uikit/UIViewPropertyAnimator) APIs. /// -@available(iOS 10.0, tvOS 10.0, *) open class InterruptibleTransitionAnimation: InteractiveTransitionAnimation { // MARK: Stored properties diff --git a/Sources/XCoordinator/StaticTransitionAnimation.swift b/Sources/XCoordinator/Animations/StaticTransitionAnimation.swift similarity index 94% rename from Sources/XCoordinator/StaticTransitionAnimation.swift rename to Sources/XCoordinator/Animations/StaticTransitionAnimation.swift index 102edab0..8bad66c2 100755 --- a/Sources/XCoordinator/StaticTransitionAnimation.swift +++ b/Sources/XCoordinator/Animations/StaticTransitionAnimation.swift @@ -38,10 +38,8 @@ open class StaticTransitionAnimation: NSObject, TransitionAnimation { /// /// - Parameters: /// - duration: The total duration of the animation. - /// - performAnimation: A closure performing the animation. - /// - context: - /// From the context, you can access source and destination views and - /// viewControllers and the containerView. + /// - performAnimation: A closure performing the animation. From the closure's `context`, + /// you can access source and destination views and viewControllers and the containerView. /// public init(duration: TimeInterval, performAnimation: @escaping (_ context: UIViewControllerContextTransitioning) -> Void) { self.duration = duration diff --git a/Sources/XCoordinator/TransitionAnimation.swift b/Sources/XCoordinator/Animations/TransitionAnimation.swift similarity index 100% rename from Sources/XCoordinator/TransitionAnimation.swift rename to Sources/XCoordinator/Animations/TransitionAnimation.swift diff --git a/Sources/XCoordinator/AnyCoordinator.swift b/Sources/XCoordinator/AnyCoordinator.swift deleted file mode 100755 index 905ac917..00000000 --- a/Sources/XCoordinator/AnyCoordinator.swift +++ /dev/null @@ -1,115 +0,0 @@ -// -// AnyCoordinator.swift -// XCoordinator -// -// Created by Paul Kraft on 25.10.18. -// Copyright © 2018 QuickBird Studios. All rights reserved. -// - -import UIKit - -/// A type-erased Coordinator (`AnyCoordinator`) with a `UINavigationController` as rootViewController. -public typealias AnyNavigationCoordinator = AnyCoordinator - -/// A type-erased Coordinator (`AnyCoordinator`) with a `UITabBarController` as rootViewController. -public typealias AnyTabBarCoordinator = AnyCoordinator - -/// A type-erased Coordinator (`AnyCoordinator`) with a `UIViewController` as rootViewController. -public typealias AnyViewCoordinator = AnyCoordinator - -/// -/// `AnyCoordinator` is a type-erased `Coordinator` (`RouteType` & `TransitionType`) and -/// can be used as an abstraction from a specific coordinator class while still specifying -/// TransitionType and RouteType. -/// -/// - Note: -/// If you do not want/need to specify TransitionType, you might want to look into the -/// different router abstractions `StrongRouter`, `UnownedRouter` and `WeakRouter`. -/// See `AnyTransitionPerformer` to further abstract from RouteType. -/// -public class AnyCoordinator: Coordinator { - - // MARK: Stored properties - - private let _prepareTransition: (RouteType) -> TransitionType - private let _viewController: () -> UIViewController? - private let _rootViewController: () -> TransitionType.RootViewController - private let _presented: (Presentable?) -> Void - private let _setRoot: (UIWindow) -> Void - private let _addChild: (Presentable) -> Void - private let _removeChild: (Presentable) -> Void - private let _removeChildrenIfNeeded: () -> Void - private let _registerParent: (Presentable & AnyObject) -> Void - - // MARK: Initialization - - /// - /// Creates a type-erased Coordinator for a specific coordinator. - /// - /// A strong reference to the source coordinator is kept. - /// - /// - Parameter coordinator: - /// The source coordinator. - /// - public init(_ coordinator: C) where C.RouteType == RouteType, C.TransitionType == TransitionType { - self._prepareTransition = coordinator.prepareTransition - self._viewController = { coordinator.viewController } - self._rootViewController = { coordinator.rootViewController } - self._presented = coordinator.presented - self._setRoot = coordinator.setRoot - self._addChild = coordinator.addChild - self._removeChild = coordinator.removeChild - self._removeChildrenIfNeeded = coordinator.removeChildrenIfNeeded - self._registerParent = coordinator.registerParent - } - - // MARK: Computed properties - - public var rootViewController: TransitionType.RootViewController { - _rootViewController() - } - - public var viewController: UIViewController! { - _viewController() - } - - // MARK: Methods - - /// - /// Prepare and return transitions for a given route. - /// - /// - Parameter route: - /// The triggered route for which a transition is to be prepared. - /// - /// - Returns: - /// The prepared transition. - /// - public func prepareTransition(for route: RouteType) -> TransitionType { - _prepareTransition(route) - } - - public func presented(from presentable: Presentable?) { - _presented(presentable) - } - - public func registerParent(_ presentable: Presentable & AnyObject) { - _registerParent(presentable) - } - - public func setRoot(for window: UIWindow) { - _setRoot(window) - } - - public func addChild(_ presentable: Presentable) { - _addChild(presentable) - } - - public func removeChild(_ presentable: Presentable) { - _removeChild(presentable) - } - - public func removeChildrenIfNeeded() { - _removeChildrenIfNeeded() - } - -} diff --git a/Sources/XCoordinator/AnyTransitionPerformer.swift b/Sources/XCoordinator/AnyTransitionPerformer.swift deleted file mode 100755 index 9a677a12..00000000 --- a/Sources/XCoordinator/AnyTransitionPerformer.swift +++ /dev/null @@ -1,58 +0,0 @@ -// -// AnyTransitionPerformer.swift -// XCoordinator -// -// Created by Paul Kraft on 13.09.18. -// Copyright © 2018 QuickBird Studios. All rights reserved. -// - -import UIKit - -/// -/// AnyTransitionPerformer can be used as an abstraction from a specific TransitionPerformer implementation -/// without losing type information about its TransitionType. -/// -/// This type abstraction can be especially helpful when performing transitions. -/// AnyTransitionPerformer abstracts away any implementation specific details and reduces coordinators to the capabilities -/// of the `TransitionPerformer` protocol. -/// -public class AnyTransitionPerformer: TransitionPerformer { - - // MARK: Stored properties - - private var _viewController: () -> UIViewController? - private var _rootViewController: () -> TransitionType.RootViewController - private var _presented: (Presentable?) -> Void - private var _perform: (TransitionType, TransitionOptions, PresentationHandler?) -> Void - - // MARK: Computed properties - - public var viewController: UIViewController! { - _viewController() - } - - public var rootViewController: TransitionType.RootViewController { - _rootViewController() - } - - // MARK: Methods - - public func presented(from presentable: Presentable?) { - _presented(presentable) - } - - public func performTransition(_ transition: TransitionType, - with options: TransitionOptions, - completion: PresentationHandler? = nil) { - _perform(transition, options, completion) - } - - // MARK: Initialization - - init(_ coordinator: T) where TransitionType == T.TransitionType { - self._viewController = { coordinator.viewController } - self._presented = coordinator.presented - self._rootViewController = { coordinator.rootViewController } - self._perform = coordinator.performTransition - } -} diff --git a/Sources/XCoordinator/BasicCoordinator.swift b/Sources/XCoordinator/BasicCoordinator.swift deleted file mode 100755 index 8c94cabc..00000000 --- a/Sources/XCoordinator/BasicCoordinator.swift +++ /dev/null @@ -1,105 +0,0 @@ -// -// BasicCoordinator.swift -// XCoordinator -// -// Created by Stefan Kofler on 05.05.18. -// Copyright © 2018 QuickBird Studios. All rights reserved. -// - -/// A BasicCoordinator with a `UINavigationController` as its rootViewController. -public typealias BasicNavigationCoordinator = BasicCoordinator - -/// A BasicCoordinator with a `UIViewController` as its rootViewController. -public typealias BasicViewCoordinator = BasicCoordinator - -/// A BasicCoordinator with a `UITabBarController` as its rootViewController. -public typealias BasicTabBarCoordinator = BasicCoordinator - -/// -/// BasicCoordinator is a coordinator class that can be used without subclassing. -/// -/// Although subclassing of coordinators is encouraged for more complex cases, a `BasicCoordinator` can easily -/// be created by only providing a `prepareTransition` closure, an `initialRoute` and an `initialLoadingType`. -/// -open class BasicCoordinator: BaseCoordinator { - - // MARK: Nested types - - /// - /// `InitialLoadingType` differentiates between different points in time when the initital route is to - /// be triggered by the coordinator. - /// - public enum InitialLoadingType { - - /// The initial route is triggered before the coordinator is made visible (i.e. on initialization). - case immediately - - /// The initial route is triggered after the coordinator is made visible. - case presented - } - - // MARK: Stored properties - - private let initialRoute: RouteType? - private let initialLoadingType: InitialLoadingType - private let prepareTransition: ((RouteType) -> TransitionType)? - - // MARK: Initialization - - /// - /// Creates a BasicCoordinator. - /// - /// - Parameters: - /// - initialRoute: - /// If a route is specified, it is triggered depending on the initialLoadingType. - /// - initialLoadingType: - /// The initialLoadingType specifies when the initialRoute is triggered. - /// - prepareTransition: - /// A closure to define transitions based on triggered routes. - /// Make sure to override `prepareTransition` by subclassing, if you specify `nil` here. - /// - /// - Seealso: - /// See `InitialLoadingType` for more information. - /// - public init(rootViewController: RootViewController, - initialRoute: RouteType? = nil, - initialLoadingType: InitialLoadingType = .presented, - prepareTransition: ((RouteType) -> TransitionType)?) { - self.initialRoute = initialRoute - self.initialLoadingType = initialLoadingType - self.prepareTransition = prepareTransition - - if initialLoadingType == .immediately { - super.init(rootViewController: rootViewController, initialRoute: initialRoute) - } else { - super.init(rootViewController: rootViewController, initialRoute: nil) - } - } - - // MARK: Open methods - - /// - /// This method is called whenever the BasicCoordinator is shown to the user. - /// - /// If `initialLoadingType` has been specified as `presented` and an initialRoute is present, - /// the route is triggered here. - /// - /// - Parameter presentable: - /// The context in which this coordinator has been shown to the user. - /// - open override func presented(from presentable: Presentable?) { - super.presented(from: presentable) - - if let initialRoute = initialRoute, initialLoadingType == .presented { - trigger(initialRoute, with: TransitionOptions(animated: false), completion: nil) - } - } - - open override func prepareTransition(for route: RouteType) -> TransitionType { - if let prepareTransition = prepareTransition { - return prepareTransition(route) - } else { - fatalError("Either pass a \(#function) closure to the initializer or override this method.") - } - } -} diff --git a/Sources/XCoordinator/Combine/Router+Combine.swift b/Sources/XCoordinator/Combine/Router+Combine.swift new file mode 100644 index 00000000..ed4f2c55 --- /dev/null +++ b/Sources/XCoordinator/Combine/Router+Combine.swift @@ -0,0 +1,122 @@ +// +// Router+Combine.swift +// XCoordinator +// +// Created by Paul Kraft on 28.08.19. +// Copyright © 2019 QuickBird Studios. All rights reserved. +// + +#if canImport(Combine) + +import Combine + +/// +/// A namespace for Combine publishers exposed by a base value. +/// +/// Routers expose this namespace via `router.publishers`, mirroring the `router.rx` namespace +/// in `XCoordinatorRx`. Use the methods on this type — `trigger(_:with:)` and +/// `contextTrigger(_:with:)` — to obtain publishers for route triggers. +/// +@MainActor +public struct PublisherExtension { + + /// The underlying value (typically a `Router`) this namespace wraps. + public let base: Base +} + +extension Router { + + /// The Combine namespace for this router. + /// + /// Use `router.publishers.trigger(_:)` to obtain a publisher that performs the route's transition + /// when subscribed to and completes when the transition finishes. + public var publishers: PublisherExtension { + .init(base: self) + } + + /// + /// Triggers a route and returns a publisher that completes when the transition finishes. + /// + /// The transition is performed on **subscription** (the returned publisher is lazy), so no + /// navigation happens until a subscriber attaches. Prefer the convenience accessor ``publishers`` + /// for new code: `router.publishers.trigger(.home)`. + /// + /// - Parameters: + /// - route: The route to trigger. + /// - options: Transition options. Defaults to animated. + /// - Returns: A publisher that emits `()` and finishes once the transition completes. + /// + public func triggerPublisher( + _ route: RouteType, + with options: TransitionOptions = .init(animated: true) + ) -> AnyPublisher { + Deferred { + Future { completion in + self.trigger(route, with: options) { + completion(.success(())) + } + } + } + .eraseToAnyPublisher() + } + + /// + /// Triggers a route and returns a publisher that emits the resulting transition context. + /// + /// The transition is performed on **subscription** (the returned publisher is lazy). Useful for + /// deep linking. Prefer ``publishers`` for new code: `router.publishers.contextTrigger(.home)`. + /// + /// - Parameters: + /// - route: The route to trigger. + /// - options: Transition options. Defaults to animated. + /// - Returns: A publisher that emits the transition context and finishes. + /// + public func contextTriggerPublisher( + _ route: RouteType, + with options: TransitionOptions = .init(animated: true) + ) -> AnyPublisher { + Deferred { + Future { completion in + self.contextTrigger(route, with: options) { + completion(.success($0)) + } + } + } + .eraseToAnyPublisher() + } + +} + +extension PublisherExtension where Base: Router { + + /// Triggers a route on the wrapped router and returns a publisher that completes when the transition finishes. + /// + /// The transition is performed on subscription (lazy). + /// + /// - Parameters: + /// - route: The route to trigger. + /// - options: Transition options. Defaults to animated. + public func trigger( + _ route: Base.RouteType, + with options: TransitionOptions = .init(animated: true) + ) -> AnyPublisher { + base.triggerPublisher(route, with: options) + } + + /// Triggers a route on the wrapped router and returns a publisher emitting the resulting transition context. + /// + /// The transition is performed on subscription (lazy). + /// + /// - Parameters: + /// - route: The route to trigger. + /// - options: Transition options. Defaults to animated. + public func contextTrigger( + _ route: Base.RouteType, + with options: TransitionOptions = .init(animated: true) + ) -> AnyPublisher { + base.contextTriggerPublisher(route, with: options) + } + +} + +#endif diff --git a/Sources/XCoordinator/Coordinator.swift b/Sources/XCoordinator/Coordinator.swift deleted file mode 100755 index 59acc646..00000000 --- a/Sources/XCoordinator/Coordinator.swift +++ /dev/null @@ -1,142 +0,0 @@ -// -// Coordinator.swift -// XCoordinator -// -// Created by Stefan Kofler on 30.04.18. -// Copyright © 2018 QuickBird Studios. All rights reserved. -// - -import UIKit - -/// The completion handler for transitions. -public typealias PresentationHandler = () -> Void - -/// The completion handler for transitions, which also provides the context information about the transition. -public typealias ContextPresentationHandler = (TransitionContext) -> Void - -/// -/// Coordinator is the protocol every coordinator conforms to. -/// -/// It requires an object to be able to trigger routes and perform transitions. -/// This connection is created using the `prepareTransition(for:)` method. -/// -public protocol Coordinator: Router, TransitionPerformer { - - /// - /// This method prepares transitions for routes. - /// It especially decides, which transitions are performed for the triggered routes. - /// - /// - Parameter route: - /// The triggered route for which a transition is to be prepared. - /// - /// - Returns: - /// The prepared transition. - /// - func prepareTransition(for route: RouteType) -> TransitionType - - /// - /// This method adds a child to a coordinator's children. - /// - /// - Parameter presentable: - /// The child to be added. - /// - func addChild(_ presentable: Presentable) - - /// - /// This method removes a child to a coordinator's children. - /// - /// - Parameter presentable: - /// The child to be removed. - /// - func removeChild(_ presentable: Presentable) - - /// This method removes all children that are no longer in the view hierarchy. - func removeChildrenIfNeeded() -} - -// MARK: - Typealiases - -extension Coordinator { - - /// Shortcut for Coordinator.TransitionType.RootViewController - public typealias RootViewController = TransitionType.RootViewController -} - -// MARK: - Presentable - -extension Coordinator { - - /// A Coordinator uses its rootViewController as viewController. - public var viewController: UIViewController! { - rootViewController - } -} - -extension Coordinator where Self: AnyObject { - - /// - /// Creates a WeakRouter object from the given router to abstract from concrete implementations - /// while maintaining information necessary to fulfill the Router protocol. - /// The original router will be held weakly. - /// - public var weakRouter: WeakRouter { - WeakRouter(self) { $0.strongRouter } - } - - /// - /// Creates an UnownedRouter object from the given router to abstract from concrete implementations - /// while maintaining information necessary to fulfill the Router protocol. - /// The original router will be held unowned. - /// - - public var unownedRouter: UnownedRouter { - UnownedRouter(self) { $0.strongRouter } - } - -} - -// MARK: - Default implementations - -extension Coordinator where Self: AnyObject { - - /// Creates an AnyCoordinator based on the current coordinator. - public var anyCoordinator: AnyCoordinator { - AnyCoordinator(self) - } - - public func presented(from presentable: Presentable?) {} - - public func childTransitionCompleted() { - removeChildrenIfNeeded() - } - - public func contextTrigger(_ route: RouteType, - with options: TransitionOptions, - completion: ContextPresentationHandler?) { - let transition = prepareTransition(for: route) - performTransition(transition, with: options) { completion?(transition) } - } - - /// - /// With `chain(routes:)` different routes can be chained together to form a combined transition. - /// - /// - Parameter routes: - /// The routes to be chained. - /// - /// - Returns: - /// A transition combining the transitions of the specified routes. - /// - public func chain(routes: [RouteType]) -> TransitionType { - .multiple(routes.map(prepareTransition)) - } - - public func performTransition(_ transition: TransitionType, - with options: TransitionOptions, - completion: PresentationHandler? = nil) { - transition.presentables.forEach(addChild) - transition.perform(on: rootViewController, with: options) { - completion?() - self.removeChildrenIfNeeded() - } - } -} diff --git a/Sources/XCoordinator/CoordinatorPreviewingDelegateObject.swift b/Sources/XCoordinator/CoordinatorPreviewingDelegateObject.swift deleted file mode 100755 index 68d7fe6d..00000000 --- a/Sources/XCoordinator/CoordinatorPreviewingDelegateObject.swift +++ /dev/null @@ -1,53 +0,0 @@ -// -// CoordinatorPreviewingDelegateObject.swift -// XCoordinator -// -// Created by Stefan Kofler on 19.07.18. -// Copyright © 2018 QuickBird Studios. All rights reserved. -// - -import UIKit - -internal class CoordinatorPreviewingDelegateObject: -NSObject, UIViewControllerPreviewingDelegate { - - // MARK: Stored properties - - internal var context: UIViewControllerPreviewing? - - private weak var viewController: UIViewController? - - private let transition: () -> TransitionType - private let rootViewController: TransitionType.RootViewController - private let completion: PresentationHandler? - - // MARK: Initialization - - internal init(transition: @escaping () -> TransitionType, - rootViewController: TransitionType.RootViewController, - completion: PresentationHandler?) { - self.transition = transition - self.rootViewController = rootViewController - self.completion = completion - } - - // MARK: Methods - - internal func previewingContext(_ previewingContext: UIViewControllerPreviewing, - viewControllerForLocation location: CGPoint) -> UIViewController? { - - if let viewController = viewController { - return viewController - } - - let presentable = transition().presentables.last - presentable?.presented(from: nil) - viewController = presentable?.viewController - return viewController - } - - internal func previewingContext(_ previewingContext: UIViewControllerPreviewing, - commit viewControllerToCommit: UIViewController) { - transition().perform(on: rootViewController, with: .default, completion: completion) - } -} diff --git a/Sources/XCoordinator/BaseCoordinator.swift b/Sources/XCoordinator/Coordinators/BaseCoordinator.swift similarity index 72% rename from Sources/XCoordinator/BaseCoordinator.swift rename to Sources/XCoordinator/Coordinators/BaseCoordinator.swift index 1ecacdc3..1ae1b1ef 100755 --- a/Sources/XCoordinator/BaseCoordinator.swift +++ b/Sources/XCoordinator/Coordinators/BaseCoordinator.swift @@ -8,11 +8,6 @@ import UIKit -extension BaseCoordinator { - /// Shortcut for `BaseCoordinator.TransitionType.RootViewController` - public typealias RootViewController = TransitionType.RootViewController -} - /// /// BaseCoordinator can (and is encouraged to) be used as a superclass for any custom implementation of a coordinator. /// @@ -20,7 +15,8 @@ extension BaseCoordinator { /// `NavigationCoordinator`, `TabBarCoordinator`, `ViewCoordinator`, `SplitCoordinator` /// and `PageCoordinator`. /// -open class BaseCoordinator: Coordinator { +@MainActor +open class BaseCoordinator: Coordinator { // MARK: Stored properties @@ -32,12 +28,17 @@ open class BaseCoordinator /// When performing a transition, children are automatically added and removed from this array /// depending on whether they are in the view hierarchy. /// - public private(set) var children = [Presentable]() + public private(set) var children = [any Presentable]() // MARK: Computed properties + /// The root view controller of this coordinator's flow. + /// + /// Its concrete type is the coordinator's `RootViewController` — e.g. a `UINavigationController` + /// for a `NavigationCoordinator`. Transitions on this coordinator are performed against it. public private(set) var rootViewController: RootViewController - + + /// The presentable view controller for this coordinator. Returns ``rootViewController`` by default. open var viewController: UIViewController! { rootViewController } @@ -45,10 +46,11 @@ open class BaseCoordinator // MARK: Initialization /// - /// This initializer trigger a route before the coordinator is made visible. + /// Creates a coordinator and optionally triggers a route before the coordinator is made visible. /// - /// - Parameter initialRoute: - /// If a route is specified, it is triggered before making the coordinator visible. + /// - Parameters: + /// - rootViewController: The root view controller for this coordinator's flow. + /// - initialRoute: A route to trigger before the coordinator becomes visible. Pass `nil` to skip. /// public init(rootViewController: RootViewController, initialRoute: RouteType?) { self.rootViewController = rootViewController @@ -56,38 +58,63 @@ open class BaseCoordinator } /// - /// This initializer performs a transition before the coordinator is made visible. + /// Creates a coordinator and optionally performs a transition before the coordinator is made visible. /// - /// - Parameter initialTransition: - /// If a transition is specified, it is performed before making the coordinator visible. + /// - Parameters: + /// - rootViewController: The root view controller for this coordinator's flow. + /// - initialTransition: A transition to perform before the coordinator becomes visible. Pass `nil` to skip. /// - public init(rootViewController: RootViewController, initialTransition: TransitionType?) { + public init(rootViewController: RootViewController, initialTransition: Transition?) { self.rootViewController = rootViewController initialTransition.map(performTransitionAfterWindowAppeared) } + /// + /// Creates a coordinator and performs an initial transition — described with the transition builder — + /// before the coordinator is made visible. + /// + /// - Parameters: + /// - rootViewController: The root view controller for this coordinator's flow. + /// - initialTransition: A transition-builder closure describing the transition to perform. + /// + public init(rootViewController: RootViewController, + @TransitionBuilder initialTransition: () -> Transition) { + self.rootViewController = rootViewController + performTransitionAfterWindowAppeared(initialTransition()) + } + // MARK: Open methods - open func presented(from presentable: Presentable?) {} + /// Returns this coordinator as a router for `route`, if it handles that route type. + /// + /// - Note: This matches only when `self` is a `BaseCoordinator` — i.e. the + /// same `RouteType` *and* the same `RootViewController`. It intentionally does not search child + /// coordinators; deep linking traverses the coordinator tree via the transition's `presentables` + /// (see `DeepLinking.swift`), and SwiftUI lookups register routers explicitly in the `RoutingContext`. + public func router(for route: R.Type) -> (any Router)? { + self as? BaseCoordinator + } + + open func presented(from presentable: (any Presentable)?) {} public func removeChildrenIfNeeded() { children.removeAll { $0.canBeRemovedAsChild() } removeParentChildren() } - public func addChild(_ presentable: Presentable) { + public func addChild(_ presentable: any Presentable) { children.append(presentable) presentable.registerParent(self) } - public func removeChild(_ presentable: Presentable) { + public func removeChild(_ presentable: any Presentable) { children.removeAll { $0.viewController === presentable.viewController } removeChildrenIfNeeded() } /// /// This method prepares transitions for routes. - /// Override this method to define transitions for triggered routes. + /// Override this method to define transitions for triggered routes, using the transition builder DSL. /// /// - Parameter route: /// The triggered route for which a transition is to be prepared. @@ -95,27 +122,27 @@ open class BaseCoordinator /// - Returns: /// The prepared transition. /// - open func prepareTransition(for route: RouteType) -> TransitionType { + @TransitionBuilder + open func prepareTransition(for route: RouteType) -> Transition { fatalError("Please override the \(#function) method.") } - - public func registerParent(_ presentable: Presentable & AnyObject) { + + public func registerParent(_ presentable: any Presentable & AnyObject) { let previous = removeParentChildren removeParentChildren = { [weak presentable] in previous() presentable?.childTransitionCompleted() } } - - @available(iOS, unavailable, message: "Please specify the rootViewController in the initializer of your coordinator instead.") - open func generateRootViewController() -> RootViewController { - .init() - } // MARK: Private methods - private func performTransitionAfterWindowAppeared(_ transition: TransitionType) { - guard !UIApplication.shared.windows.contains(where: { $0.isKeyWindow }) else { + private func performTransitionAfterWindowAppeared(_ transition: Transition) { + let hasKeyWindow = UIApplication.shared.connectedScenes + .compactMap { $0 as? UIWindowScene } + .flatMap(\.windows) + .contains(where: \.isKeyWindow) + guard !hasKeyWindow else { return performTransition(transition, with: TransitionOptions(animated: false)) } @@ -136,7 +163,7 @@ extension Presentable { fileprivate func canBeRemovedAsChild() -> Bool { guard !(self is UIViewController) else { return true } - guard let viewController = viewController else { return true } + guard let viewController else { return true } return !viewController.isInViewHierarchy && viewController.children.allSatisfy { $0.canBeRemovedAsChild() } } @@ -150,7 +177,7 @@ extension UIViewController { || presentingViewController != nil || presentedViewController != nil || parent != nil - || view.window != nil + || viewIfLoaded?.window != nil || navigationController != nil || tabBarController != nil || splitViewController != nil @@ -183,12 +210,10 @@ extension BaseCoordinator { /// - recognizer: /// The gesture recognizer to be used to update the interactive transition. /// - handler: - /// The handler to update the interaction controller of the animation generated by the given `transition` closure. - /// - handlerRecognizer: - /// The gestureRecognizer with which the handler has been registered. - /// - transition: - /// The closure to perform the transition. It returns the transition animation to control the interaction controller of. - /// `TransitionAnimation.start()` is automatically called. + /// The handler to update the interaction controller of the animation generated by the transition closure. + /// It receives the gestureRecognizer with which the handler has been registered, and a closure to perform + /// the transition — which returns the transition animation to control the interaction controller of + /// (`TransitionAnimation.start()` is automatically called). /// - completion: /// The closure to be called whenever the transition completes. /// Hint: Might be called multiple times but only once per performing the transition. diff --git a/Sources/XCoordinator/Coordinators/BasicCoordinator.swift b/Sources/XCoordinator/Coordinators/BasicCoordinator.swift new file mode 100755 index 00000000..3acd652e --- /dev/null +++ b/Sources/XCoordinator/Coordinators/BasicCoordinator.swift @@ -0,0 +1,135 @@ +// +// BasicCoordinator.swift +// XCoordinator +// +// Created by Stefan Kofler on 05.05.18. +// Copyright © 2018 QuickBird Studios. All rights reserved. +// + +import UIKit + +/// A BasicCoordinator with a `UINavigationController` as its rootViewController. +public typealias BasicNavigationCoordinator = BasicCoordinator + +/// A BasicCoordinator with a `UIViewController` as its rootViewController. +public typealias BasicViewCoordinator = BasicCoordinator + +/// A BasicCoordinator with a `UITabBarController` as its rootViewController. +public typealias BasicTabBarCoordinator = BasicCoordinator + +/// +/// BasicCoordinator is a coordinator class that can be used without subclassing. +/// +/// Although subclassing of coordinators is encouraged for more complex cases, a `BasicCoordinator` can easily +/// be created by only providing a `prepare` closure, an `initialRoute` and an `initialLoadingType`. +/// +open class BasicCoordinator: BaseCoordinator { + + // MARK: Nested types + + /// + /// `InitialLoadingType` differentiates between different points in time when the initital route is to + /// be triggered by the coordinator. + /// + public enum InitialLoadingType { + + /// The initial route is triggered before the coordinator is made visible (i.e. on initialization). + case immediately + + /// The initial route is triggered after the coordinator is made visible. + case presented + } + + // MARK: Stored properties + + private let initialRoute: RouteType? + private let initialLoadingType: InitialLoadingType + private let prepareClosure: ((RouteType) -> Transition)? + + // MARK: Initialization + + /// + /// Creates a BasicCoordinator whose transitions are defined inline with the transition builder. + /// + /// The `prepare` closure is a `@TransitionBuilder`, so its body lists the same `Transition.…` + /// factories as an overridden `prepareTransition(for:)`: + /// + /// ```swift + /// BasicNavigationCoordinator(rootViewController: .init(), initialRoute: .home) { route in + /// switch route { + /// case .home: Transition.show(HomeViewController()) + /// case .detail: Transition.push(DetailViewController()) + /// } + /// } + /// ``` + /// + /// - Parameters: + /// - rootViewController: The view controller that hosts the coordinator's transitions. + /// - initialRoute: If specified, this route is triggered depending on `initialLoadingType`. + /// - initialLoadingType: Determines when `initialRoute` is triggered. See ``InitialLoadingType``. + /// - prepare: A transition-builder closure returning the transition for each triggered route. + /// + public init(rootViewController: RootViewController, + initialRoute: RouteType? = nil, + initialLoadingType: InitialLoadingType = .presented, + @TransitionBuilder prepare: @escaping (RouteType) -> Transition) { + self.initialRoute = initialRoute + self.initialLoadingType = initialLoadingType + self.prepareClosure = prepare + + if initialLoadingType == .immediately { + super.init(rootViewController: rootViewController, initialRoute: initialRoute) + } else { + super.init(rootViewController: rootViewController, initialRoute: nil) + } + } + + /// + /// Creates a BasicCoordinator that defines its transitions by overriding ``prepareTransition(for:)`` in a subclass. + /// + /// - Parameters: + /// - rootViewController: The view controller that hosts the coordinator's transitions. + /// - initialRoute: If specified, this route is triggered depending on `initialLoadingType`. + /// - initialLoadingType: Determines when `initialRoute` is triggered. See ``InitialLoadingType``. + /// + public init(rootViewController: RootViewController, + initialRoute: RouteType? = nil, + initialLoadingType: InitialLoadingType = .presented) { + self.initialRoute = initialRoute + self.initialLoadingType = initialLoadingType + self.prepareClosure = nil + + if initialLoadingType == .immediately { + super.init(rootViewController: rootViewController, initialRoute: initialRoute) + } else { + super.init(rootViewController: rootViewController, initialRoute: nil) + } + } + + // MARK: Open methods + + /// + /// This method is called whenever the BasicCoordinator is shown to the user. + /// + /// If `initialLoadingType` has been specified as `presented` and an initialRoute is present, + /// the route is triggered here. + /// + /// - Parameter presentable: + /// The context in which this coordinator has been shown to the user. + /// + open override func presented(from presentable: (any Presentable)?) { + super.presented(from: presentable) + + if let initialRoute = initialRoute, initialLoadingType == .presented { + trigger(initialRoute, with: TransitionOptions(animated: false), completion: nil) + } + } + + open override func prepareTransition(for route: RouteType) -> Transition { + if let prepareClosure = prepareClosure { + return prepareClosure(route) + } else { + fatalError("Either pass a `prepare` closure to the initializer or override this method.") + } + } +} diff --git a/Sources/XCoordinator/Coordinators/Coordinator.swift b/Sources/XCoordinator/Coordinators/Coordinator.swift new file mode 100755 index 00000000..3baacb02 --- /dev/null +++ b/Sources/XCoordinator/Coordinators/Coordinator.swift @@ -0,0 +1,166 @@ +// +// Coordinator.swift +// XCoordinator +// +// Created by Stefan Kofler on 30.04.18. +// Copyright © 2018 QuickBird Studios. All rights reserved. +// + +import UIKit + +/// The completion handler for transitions. +public typealias PresentationHandler = () -> Void + +/// The completion handler for transitions, which also provides the context information about the transition. +public typealias ContextPresentationHandler = (any TransitionContext) -> Void + +/// +/// Coordinator is the protocol every coordinator conforms to. +/// +/// It owns a `rootViewController`, prepares a ``Transition`` for each triggered route via ``prepareTransition(for:)``, +/// and performs those transitions. Every transition is a `Transition`; the concrete +/// root-view-controller type (e.g. `UINavigationController`) determines which transitions are available. +/// +@MainActor +public protocol Coordinator: Router { + + /// The type of the rootViewController on which transitions are performed. + associatedtype RootViewController: UIViewController + + /// The rootViewController on which transitions are performed. + var rootViewController: RootViewController { get } + + /// + /// This method prepares transitions for routes. + /// It especially decides which transition is performed for a triggered route. + /// + /// - Parameter route: + /// The triggered route for which a transition is to be prepared. + /// + /// - Returns: + /// The prepared transition. + /// + @TransitionBuilder + func prepareTransition(for route: RouteType) -> Transition + + /// + /// Perform a transition. + /// + /// - Warning: + /// Do not use this method directly. Instead, trigger a route on your coordinator wherever possible. + /// + /// - Parameters: + /// - transition: The transition to be performed. + /// - options: The options on how to perform the transition, including the option to enable/disable animations. + /// - completion: The completion handler called once the transition has finished. + /// + func performTransition(_ transition: Transition, + with options: TransitionOptions, + completion: PresentationHandler?) + + /// + /// The child coordinators currently in the view hierarchy. + /// They are added and removed automatically during transitions depending on whether they are in the + /// view hierarchy. + /// + var children: [any Presentable] { get } + + /// + /// This method adds a child to a coordinator's children. + /// + /// - Parameter presentable: + /// The child to be added. + /// + func addChild(_ presentable: any Presentable) + + /// + /// This method removes a child to a coordinator's children. + /// + /// - Parameter presentable: + /// The child to be removed. + /// + func removeChild(_ presentable: any Presentable) + + /// This method removes all children that are no longer in the view hierarchy. + func removeChildrenIfNeeded() +} + +// MARK: - Presentable + +extension Coordinator { + + /// A Coordinator uses its rootViewController as viewController. + public var viewController: UIViewController! { + rootViewController + } +} + +// MARK: - Default implementations + +extension Coordinator where Self: AnyObject { + + public func presented(from presentable: (any Presentable)?) {} + + public func childTransitionCompleted() { + removeChildrenIfNeeded() + } + + public func contextTrigger(_ route: RouteType, + with options: TransitionOptions, + completion: ContextPresentationHandler?) { + let transition = prepareTransition(for: route) + performTransition(transition, with: options) { completion?(transition) } + } + + /// + /// With `chain(routes:)` different routes can be chained together to form a combined transition. + /// + /// - Parameter routes: + /// The routes to be chained. + /// + /// - Returns: + /// A transition combining the transitions of the specified routes. + /// + public func chain(routes: [RouteType]) -> Transition { + .multiple(routes.map(prepareTransition)) + } + + public func performTransition(_ transition: Transition, + with options: TransitionOptions, + completion: PresentationHandler? = nil) { + #if canImport(SwiftUI) + for presentable in transition.presentables { + // The provider is usually the presentable's view controller (a `RoutingController`), + // not the presentable (a coordinator) itself — so check both. + if let provider = presentable as? RoutingContextProvider { + provider.routingContext.add(self) + } else if let viewController = presentable.viewController, + let provider = viewController as? RoutingContextProvider { + provider.routingContext.add(self) + } + } + #endif + transition.perform(on: rootViewController, with: options) { [self] in + removeChildrenIfNeeded() + transition.presentables.forEach(addChild) + completion?() + } + } + + /// + /// Performs a transition described with the transition builder. + /// + /// - Warning: + /// Do not use this method directly. Instead, trigger a route on your coordinator wherever possible. + /// + /// - Parameters: + /// - options: The options on how to perform the transition. Defaults to animated. + /// - completion: The completion handler called once the transition has finished. + /// - transition: A transition-builder closure describing the transition to perform. + /// + public func performTransition(with options: TransitionOptions = TransitionOptions(animated: true), + completion: PresentationHandler? = nil, + @TransitionBuilder _ transition: () -> Transition) { + performTransition(transition(), with: options, completion: completion) + } +} diff --git a/Sources/XCoordinator/RedirectionRouter.swift b/Sources/XCoordinator/Coordinators/RedirectionRouter.swift similarity index 87% rename from Sources/XCoordinator/RedirectionRouter.swift rename to Sources/XCoordinator/Coordinators/RedirectionRouter.swift index 88cbf472..6284fb1d 100755 --- a/Sources/XCoordinator/RedirectionRouter.swift +++ b/Sources/XCoordinator/Coordinators/RedirectionRouter.swift @@ -24,7 +24,7 @@ open class RedirectionRouter: Router { // MARK: Stored properties /// A type-erased Router object of the parent router. - public let parent: UnownedRouter + public unowned let parent: any Router private let _map: ((RouteType) -> ParentRoute)? @@ -43,8 +43,8 @@ open class RedirectionRouter: Router { /// and an optional mapping. /// /// - Note: - /// Make sure to either override `mapToSuperRoute` or to specify a closure for the `map` parameter. - /// If you override `mapToSuperRoute`, the `map` parameter is ignored. + /// Make sure to either override ``mapToParentRoute(_:)`` or to specify a closure for the `map` parameter. + /// If you override ``mapToParentRoute(_:)``, the `map` parameter is ignored. /// /// - Parameters: /// - viewController: @@ -55,7 +55,7 @@ open class RedirectionRouter: Router { /// A mapping from this RedirectionRouter's routes to the parent's routes. /// public init(viewController: UIViewController, - parent: UnownedRouter, + parent: any Router, map: ((RouteType) -> ParentRoute)?) { self.parent = parent self._map = map @@ -64,6 +64,10 @@ open class RedirectionRouter: Router { // MARK: Methods + public func router(for route: R.Type) -> (any Router)? { + self as? RedirectionRouter + } + open func contextTrigger(_ route: RouteType, with options: TransitionOptions, completion: ContextPresentationHandler?) { diff --git a/Sources/XCoordinator/Router.swift b/Sources/XCoordinator/Coordinators/Router.swift similarity index 63% rename from Sources/XCoordinator/Router.swift rename to Sources/XCoordinator/Coordinators/Router.swift index c29929d2..76c8f4c0 100755 --- a/Sources/XCoordinator/Router.swift +++ b/Sources/XCoordinator/Coordinators/Router.swift @@ -1,5 +1,5 @@ // -// RouteTrigger.swift +// Router.swift // XCoordinator // // Created by Paul Kraft on 28.07.18. @@ -9,15 +9,15 @@ import Foundation /// -/// The Router protocol is used to abstract the transition-type specific characteristics of a Coordinator. +/// The Router protocol abstracts a coordinator down to its route-triggering capability. /// -/// A Router can trigger routes, which lead to transitions being executed. In constrast to the Coordinator protocol, -/// the router does not specify a TransitionType and can therefore be used in the form of a -/// `StrongRouter`, `UnownedRouter` or `WeakRouter` to reduce a coordinator's capabilities to -/// the triggering of routes. -/// This may especially be useful in viewModels when using them in different contexts. +/// In contrast to ``Coordinator``, `Router` does not specify a `RootViewController` and can therefore be +/// used as `any Router` to expose only the trigger surface to view models and views. +/// Pair the existential with the ARC qualifier that matches the relationship — `unowned`/`weak` for +/// child holding parent, `strong` for ownership. /// -public protocol Router: Presentable { +@MainActor +public protocol Router: Presentable, AnyObject { /// RouteType defines which routes can be triggered in a certain Router implementation. associatedtype RouteType: Route @@ -86,46 +86,14 @@ extension Router { } -extension Router { - - // MARK: Computed properties - - /// - /// Creates a StrongRouter object from the given router to abstract from concrete implementations - /// while maintaining information necessary to fulfill the Router protocol. - /// The original router will be held strongly. - /// - public var strongRouter: StrongRouter { - StrongRouter(self) - } - - /// - /// Returns a router for the specified route, if possible. - /// - /// - Parameter route: - /// The route type to return a router for. - /// - /// - Returns: - /// It returns the router's strongRouter, - /// if it is compatible with the given route type, - /// otherwise `nil`. - /// - public func router(for route: R) -> StrongRouter? { - strongRouter as? StrongRouter - } - -} - -#if swift(>=5.5.2) - -@available(iOS 13.0, tvOS 13.0, *) extension Router { /// /// Triggers the specified route with default transition options enabling the animation of the transition. /// - /// - Parameters: - /// - route: The route to be triggered. + /// Suspends until the underlying transition has completed (including any animations). + /// + /// - Parameter route: The route to be triggered. /// @MainActor public func trigger(_ route: RouteType) async { await trigger(route, with: .default) @@ -134,6 +102,8 @@ extension Router { /// /// Triggers the specified route by performing a transition. /// + /// Suspends until the underlying transition has completed (including any animations). + /// /// - Parameters: /// - route: The route to be triggered. /// - options: Transition options for performing the transition, e.g. whether it should be animated. @@ -143,30 +113,28 @@ extension Router { } /// - /// Triggers routes and returns context in completion-handler. + /// Triggers a route and returns the resulting transition context. /// - /// Useful for deep linking. It is encouraged to use `trigger` instead, if the context is not needed. + /// Useful for deep linking. Prefer `trigger(_:with:)` if the context is not needed. /// /// - Parameters: /// - route: The route to be triggered. - /// - options: - /// Transition options configuring the execution of transitions, e.g. whether it should be animated. - /// - completion: - /// If present, this completion handler is executed once the transition is completed - /// (including animations). + /// - options: Transition options configuring the execution of transitions, e.g. whether it should be animated. /// - /// - Returns: - /// The transition context of the performed transition(s). - /// If the context is not needed, use `trigger` instead. + /// - Returns: The transition context of the performed transition(s). /// - @MainActor public func contextTrigger(_ route: RouteType, with options: TransitionOptions) async -> TransitionContext { + @MainActor public func contextTrigger(_ route: RouteType, with options: TransitionOptions) async -> any TransitionContext { await withCheckedContinuation { continuation in + // Some transitions (e.g. interactive ones, or custom `Transition.PerformClosure`s) may invoke + // their completion more than once. A checked continuation must be resumed exactly once, so we + // guard against the redundant calls to avoid a hard crash. + var resumed = false contextTrigger(route, with: options) { context in + guard !resumed else { return } + resumed = true continuation.resume(returning: context) } } } } - -#endif diff --git a/Sources/XCoordinator/Extensions/NSObject+References.swift b/Sources/XCoordinator/Extensions/NSObject+References.swift new file mode 100755 index 00000000..2f64b585 --- /dev/null +++ b/Sources/XCoordinator/Extensions/NSObject+References.swift @@ -0,0 +1,25 @@ +// +// NSObject+References.swift +// XCoordinator +// +// Created by Stefan Kofler on 19.07.18. +// Copyright © 2018 QuickBird Studios. All rights reserved. +// + +import Foundation + +private var associatedObjectHandle: UInt8 = 0 + +extension NSObject { + + internal var strongReferences: [Any] { + get { + objc_getAssociatedObject(self, &associatedObjectHandle) as? [Any] ?? [] + } + set { + objc_setAssociatedObject(self, &associatedObjectHandle, newValue, .OBJC_ASSOCIATION_RETAIN_NONATOMIC) + } + } + +} + diff --git a/Sources/XCoordinator/Container.swift b/Sources/XCoordinator/General/Container.swift similarity index 100% rename from Sources/XCoordinator/Container.swift rename to Sources/XCoordinator/General/Container.swift diff --git a/Sources/XCoordinator/DeepLinking.swift b/Sources/XCoordinator/General/DeepLinking.swift similarity index 76% rename from Sources/XCoordinator/DeepLinking.swift rename to Sources/XCoordinator/General/DeepLinking.swift index 5c356ffa..36d8b939 100755 --- a/Sources/XCoordinator/DeepLinking.swift +++ b/Sources/XCoordinator/General/DeepLinking.swift @@ -6,26 +6,7 @@ // Copyright © 2018 QuickBird Studios. All rights reserved. // -/// -/// `TransitionContext` provides context information about transitions. -/// -/// It is especially useful for deep linking as XCoordinator can internally gather information about -/// the presentables being pushed onto the view hierarchy. -/// -public protocol TransitionContext { - - /// The presentables being shown to the user by the transition. - var presentables: [Presentable] { get } - - /// - /// The transition animation directly used in the transition, if applicable. - /// - /// - Note: - /// Make sure to not return `nil`, if you want to use `BaseCoordinator.registerInteractiveTransition` - /// to realize an interactive transition. - /// - var animation: TransitionAnimation? { get } -} +import UIKit // MARK: - Coordinator + DeepLinking @@ -46,15 +27,15 @@ extension Coordinator where Self: AnyObject { /// Keep in mind that changes in the app's structure and changes of transitions /// behind the given routes can lead to runtime errors and, therefore, crashes of your app. /// - public func deepLink(_ route: RouteType, _ remainingRoutes: S) - -> Transition where S.Element == Route, TransitionType == Transition { + public func deepLink(_ route: RouteType, _ remainingRoutes: S) + -> Transition where S.Element == Route { .deepLink(with: self, route, array: Array(remainingRoutes)) } /// /// Deep-Linking can be used to chain routes of different types together. /// - /// - Parameters + /// - Parameters: /// - route: /// The first route in the chain. /// It is given a special place because its exact type can be specified. @@ -64,8 +45,8 @@ extension Coordinator where Self: AnyObject { /// Keep in mind that changes in the app's structure and changes of transitions /// behind the given routes can lead to runtime errors and, therefore, crashes of your app. /// - public func deepLink(_ route: RouteType, _ remainingRoutes: Route...) - -> Transition where TransitionType == Transition { + public func deepLink(_ route: RouteType, _ remainingRoutes: Route...) + -> Transition { .deepLink(with: self, route, array: remainingRoutes) } } @@ -93,9 +74,10 @@ extension Transition { // MARK: - Route + DeepLink extension Route { - private func router(fromStack stack: inout [Presentable]) -> StrongRouter? { + @MainActor + private func router(fromStack stack: inout [Presentable]) -> (any Router)? { while !stack.isEmpty { - if let router = stack.last?.router(for: self) { + if let router = stack.last?.router(for: Self.self) { return router } stack.removeLast() @@ -103,6 +85,7 @@ extension Route { return nil } + @MainActor fileprivate func trigger(on presentables: [Presentable], remainingRoutes: ArraySlice, with options: TransitionOptions, diff --git a/Sources/XCoordinator/Presentable.swift b/Sources/XCoordinator/General/Presentable.swift similarity index 75% rename from Sources/XCoordinator/Presentable.swift rename to Sources/XCoordinator/General/Presentable.swift index 88012106..57bbf757 100755 --- a/Sources/XCoordinator/Presentable.swift +++ b/Sources/XCoordinator/General/Presentable.swift @@ -14,6 +14,7 @@ import UIKit /// Therefore, it is useful for view controllers, coordinators and views. /// Presentable is often used for transitions to allow for view controllers and coordinators to be transitioned to. /// +@MainActor public protocol Presentable { /// @@ -33,7 +34,7 @@ public protocol Presentable { /// - Parameter route: /// The route to determine a router for. /// - func router(for route: R) -> StrongRouter? + func router(for route: R.Type) -> (any Router)? /// /// This method is called whenever a Presentable is shown to the user. @@ -44,7 +45,7 @@ public protocol Presentable { /// This could be a window, another viewController, a coordinator, etc. /// `nil` is specified whenever a context cannot be easily determined. /// - func presented(from presentable: Presentable?) + func presented(from presentable: (any Presentable)?) /// /// This method is used to register a parent coordinator to a child coordinator. @@ -52,7 +53,7 @@ public protocol Presentable { /// - Note: /// This method is used internally and should never be called directly. /// - func registerParent(_ presentable: Presentable & AnyObject) + func registerParent(_ presentable: any Presentable & AnyObject) /// /// This method gets called when the transition of a child coordinator is being reported to its parent. @@ -76,22 +77,35 @@ public protocol Presentable { extension Presentable { - public func registerParent(_ presentable: Presentable & AnyObject) {} + public func registerParent(_ presentable: any Presentable & AnyObject) {} public func childTransitionCompleted() {} public func setRoot(for window: UIWindow) { + let previousRoot = window.rootViewController window.rootViewController = viewController window.makeKeyAndVisible() presented(from: window) - } - public func router(for route: R) -> StrongRouter? { - self as? StrongRouter + if let previousRoot { + previousRoot.removeFromParent() + previousRoot.dismiss(animated: false) { + previousRoot.viewIfLoaded?.removeFromSuperview() + } + } } - public func presented(from presentable: Presentable?) {} + public func presented(from presentable: (any Presentable)?) {} + } -extension UIViewController: Presentable {} -extension UIWindow: Presentable {} +extension UIViewController: Presentable { + public func router(for route: R.Type) -> (any Router)? { + nil + } +} +extension UIWindow: Presentable { + public func router(for route: R.Type) -> (any Router)? { + nil + } +} diff --git a/Sources/XCoordinator/Route.swift b/Sources/XCoordinator/General/Route.swift similarity index 100% rename from Sources/XCoordinator/Route.swift rename to Sources/XCoordinator/General/Route.swift diff --git a/Sources/XCoordinator/NavigationAnimationDelegate.swift b/Sources/XCoordinator/Navigation/NavigationAnimationDelegate.swift similarity index 98% rename from Sources/XCoordinator/NavigationAnimationDelegate.swift rename to Sources/XCoordinator/Navigation/NavigationAnimationDelegate.swift index 29bf4c1e..b8f32193 100755 --- a/Sources/XCoordinator/NavigationAnimationDelegate.swift +++ b/Sources/XCoordinator/Navigation/NavigationAnimationDelegate.swift @@ -127,8 +127,8 @@ extension NavigationAnimationDelegate: UINavigationControllerDelegate { /// /// - Parameters: /// - navigationController: The delegate owner. - /// - operation: The operation being executed. Possible values are push, pop or none. /// - viewController: The target view controller. + /// - animated: Whether the transition was animated. /// open func navigationController(_ navigationController: UINavigationController, didShow viewController: UIViewController, animated: Bool) { @@ -145,8 +145,8 @@ extension NavigationAnimationDelegate: UINavigationControllerDelegate { /// /// - Parameters: /// - navigationController: The delegate owner. - /// - operation: The operation being executed. Possible values are push, pop or none. /// - viewController: The view controller to be shown. + /// - animated: Whether the transition is animated. /// open func navigationController(_ navigationController: UINavigationController, willShow viewController: UIViewController, diff --git a/Sources/XCoordinator/Navigation/NavigationCoordinator.swift b/Sources/XCoordinator/Navigation/NavigationCoordinator.swift new file mode 100755 index 00000000..e91317d6 --- /dev/null +++ b/Sources/XCoordinator/Navigation/NavigationCoordinator.swift @@ -0,0 +1,111 @@ +// +// NavigationCoordinator.swift +// XCoordinator +// +// Created by Paul Kraft on 29.07.18. +// Copyright © 2018 QuickBird Studios. All rights reserved. +// + +import UIKit + +/// +/// NavigationCoordinator acts as a base class for custom coordinators with a `UINavigationController` +/// as rootViewController. +/// +/// NavigationCoordinator especially ensures that transition animations are called, +/// which would not be the case when creating a `BaseCoordinator`. +/// +open class NavigationCoordinator: BaseCoordinator { + + // MARK: Stored properties + + /// + /// The animation delegate controlling the rootViewController's transition animations. + /// It is installed as the navigation controller's `delegate` if no delegate was set earlier. + /// + /// - Note: + /// Use the ``delegate`` property to install your own delegate while keeping XCoordinator's + /// transition animations. + /// + public let animationDelegate = NavigationAnimationDelegate() + // swiftlint:disable:previous weak_delegate + + // MARK: Computed properties + + /// + /// A fallback delegate that receives navigation-controller events not consumed by XCoordinator, + /// and is used to drive transition animations when no animation is specified by the route. + /// + public var delegate: UINavigationControllerDelegate? { + get { + animationDelegate.delegate + } + set { + animationDelegate.delegate = newValue + } + } + + // MARK: Initialization + + /// + /// Creates a NavigationCoordinator and optionally triggers an initial route. + /// + /// - Parameters: + /// - rootViewController: The `UINavigationController` to host transitions. Defaults to a fresh instance. + /// - initialRoute: A route to trigger once the coordinator is shown. Defaults to `nil`. + /// + public override init(rootViewController: RootViewController = .init(), initialRoute: RouteType? = nil) { + if rootViewController.delegate == nil { + rootViewController.delegate = animationDelegate + } + super.init(rootViewController: rootViewController, initialRoute: initialRoute) + animationDelegate.presentable = self + } + + /// + /// Creates a NavigationCoordinator and pushes a presentable onto the navigation stack right away. + /// + /// - Parameters: + /// - rootViewController: The `UINavigationController` to host transitions. Defaults to a fresh instance. + /// - root: The presentable to push as the initial view controller. + /// + public init(rootViewController: RootViewController = .init(), root: any Presentable) { + if rootViewController.delegate == nil { + rootViewController.delegate = animationDelegate + } + super.init(rootViewController: rootViewController, initialTransition: .push(root)) + animationDelegate.presentable = self + } + + /// + /// Creates a NavigationCoordinator and optionally performs an initial transition. + /// + /// - Parameters: + /// - rootViewController: The `UINavigationController` to host transitions. + /// - initialTransition: A transition to perform once the coordinator is shown. Pass `nil` to skip. + /// + public override init(rootViewController: RootViewController, initialTransition: NavigationTransition?) { + if rootViewController.delegate == nil { + rootViewController.delegate = animationDelegate + } + super.init(rootViewController: rootViewController, initialTransition: initialTransition) + animationDelegate.presentable = self + } + + /// + /// Creates a NavigationCoordinator and performs an initial transition described with the transition builder. + /// + /// - Parameters: + /// - rootViewController: The `UINavigationController` to host transitions. + /// - initialTransition: A transition-builder closure describing the transition to perform. + /// + public override init(rootViewController: RootViewController, + @TransitionBuilder initialTransition: () -> NavigationTransition) { + if rootViewController.delegate == nil { + rootViewController.delegate = animationDelegate + } + super.init(rootViewController: rootViewController, initialTransition: initialTransition()) + animationDelegate.presentable = self + } + +} diff --git a/Sources/XCoordinator/NavigationTransition.swift b/Sources/XCoordinator/Navigation/NavigationTransition.swift similarity index 94% rename from Sources/XCoordinator/NavigationTransition.swift rename to Sources/XCoordinator/Navigation/NavigationTransition.swift index 90fc3331..9e55340a 100755 --- a/Sources/XCoordinator/NavigationTransition.swift +++ b/Sources/XCoordinator/Navigation/NavigationTransition.swift @@ -26,7 +26,7 @@ extension Transition where RootViewController: UINavigationController { /// presentable before. You can use `Animation.default` to reset the previously set animations /// on this presentable. /// - public static func push(_ presentable: Presentable, animation: Animation? = nil) -> Transition { + public static func push(_ presentable: any Presentable, animation: Animation? = nil) -> Transition { Transition(presentables: [presentable], animationInUse: animation?.presentationAnimation ) { rootViewController, options, completion in @@ -74,7 +74,7 @@ extension Transition where RootViewController: UINavigationController { /// presentable before. You can use `Animation.default` to reset the previously set animations /// on this presentable. /// - public static func pop(to presentable: Presentable, animation: Animation? = nil) -> Transition { + public static func pop(to presentable: any Presentable, animation: Animation? = nil) -> Transition { Transition(presentables: [presentable], animationInUse: animation?.dismissalAnimation ) { rootViewController, options, completion in @@ -118,7 +118,7 @@ extension Transition where RootViewController: UINavigationController { /// here to leave animations as they were set for the presentables before. You can use /// `Animation.default` to reset the previously set animations on all presentables. /// - public static func set(_ presentables: [Presentable], animation: Animation? = nil) -> Transition { + public static func set(_ presentables: [any Presentable], animation: Animation? = nil) -> Transition { Transition(presentables: presentables, animationInUse: animation?.presentationAnimation ) { rootViewController, options, completion in diff --git a/Sources/XCoordinator/UINavigationController+Transition.swift b/Sources/XCoordinator/Navigation/UINavigationController+Transition.swift old mode 100755 new mode 100644 similarity index 95% rename from Sources/XCoordinator/UINavigationController+Transition.swift rename to Sources/XCoordinator/Navigation/UINavigationController+Transition.swift index 83814232..068ac629 --- a/Sources/XCoordinator/UINavigationController+Transition.swift +++ b/Sources/XCoordinator/Navigation/UINavigationController+Transition.swift @@ -9,7 +9,7 @@ import UIKit extension UINavigationController { - + func push(_ viewController: UIViewController, with options: TransitionOptions, animation: Animation?, @@ -25,14 +25,17 @@ extension UINavigationController { To set another delegate of a rootViewController in a NavigationCoordinator, have a look at `NavigationCoordinator.delegate`. """) - CATransaction.begin() - CATransaction.setCompletionBlock(completion) - autoreleasepool { pushViewController(viewController, animated: options.animated) } - CATransaction.commit() + if let transitionCoordinator { + transitionCoordinator.animate(alongsideTransition: nil) { _ in + completion?() + } + } else { + completion?() + } } func pop(toRoot: Bool, with options: TransitionOptions, animation: Animation?, completion: PresentationHandler?) { @@ -117,5 +120,5 @@ extension UINavigationController { CATransaction.commit() } - + } diff --git a/Sources/XCoordinator/NavigationCoordinator.swift b/Sources/XCoordinator/NavigationCoordinator.swift deleted file mode 100755 index f9c8b1f1..00000000 --- a/Sources/XCoordinator/NavigationCoordinator.swift +++ /dev/null @@ -1,77 +0,0 @@ -// -// NavigationCoordinator.swift -// XCoordinator -// -// Created by Paul Kraft on 29.07.18. -// Copyright © 2018 QuickBird Studios. All rights reserved. -// - -import UIKit - -/// -/// NavigationCoordinator acts as a base class for custom coordinators with a `UINavigationController` -/// as rootViewController. -/// -/// NavigationCoordinator especially ensures that transition animations are called, -/// which would not be the case when creating a `BaseCoordinator`. -/// -open class NavigationCoordinator: BaseCoordinator { - - // MARK: Stored properties - - /// - /// The animation delegate controlling the rootViewController's transition animations. - /// This animation delegate is set to be the rootViewController's rootViewController, if you did not set one earlier. - /// - /// - Note: - /// Use the `delegate` property to set a custom delegate and use transition animations provided by XCoordinator. - /// - public let animationDelegate = NavigationAnimationDelegate() - // swiftlint:disable:previous weak_delegate - - // MARK: Computed properties - - /// - /// This represents a fallback-delegate to be notified about navigation controller events. - /// It is further used to call animation methods when no animation has been specified in the transition. - /// - public var delegate: UINavigationControllerDelegate? { - get { - animationDelegate.delegate - } - set { - animationDelegate.delegate = newValue - } - } - - // MARK: Initialization - - /// - /// Creates a NavigationCoordinator and optionally triggers an initial route. - /// - /// - Parameter initialRoute: - /// The route to be triggered. - /// - public override init(rootViewController: RootViewController = .init(), initialRoute: RouteType? = nil) { - if rootViewController.delegate == nil { - rootViewController.delegate = animationDelegate - } - super.init(rootViewController: rootViewController, initialRoute: initialRoute) - animationDelegate.presentable = self - } - - /// - /// Creates a NavigationCoordinator and pushes a presentable onto the navigation stack right away. - /// - /// - Parameter root: - /// The presentable to be pushed. - /// - public init(rootViewController: RootViewController = .init(), root: Presentable) { - if rootViewController.delegate == nil { - rootViewController.delegate = animationDelegate - } - super.init(rootViewController: rootViewController, initialTransition: .push(root)) - animationDelegate.presentable = self - } - -} diff --git a/Sources/XCoordinator/Page/PageCoordinator.swift b/Sources/XCoordinator/Page/PageCoordinator.swift new file mode 100755 index 00000000..1e86b90d --- /dev/null +++ b/Sources/XCoordinator/Page/PageCoordinator.swift @@ -0,0 +1,144 @@ +// +// PageCoordinator.swift +// XCoordinator +// +// Created by Paul Kraft on 30.07.18. +// Copyright © 2018 QuickBird Studios. All rights reserved. +// + +import UIKit + +/// +/// PageCoordinator provides a base class for your custom coordinator with a `UIPageViewController` rootViewController. +/// +/// - Note: +/// PageCoordinator sets the dataSource of the rootViewController to reflect the parameters in the initializer. +/// +open class PageCoordinator: BaseCoordinator { + + // MARK: Stored properties + + /// + /// The dataSource of the rootViewController. + /// + /// Feel free to change the pages at runtime. To reflect the changes in the rootViewController, perform a `set` transition as well. + /// + public let dataSource: UIPageViewControllerDataSource + + // MARK: Initialization + + // Note: PageCoordinator intentionally does NOT expose BaseCoordinator's bare + // `init(rootViewController:initialRoute:)` / `init(rootViewController:initialTransition:)` inits. + // A page view controller needs a `dataSource` to drive swipe navigation, and that `dataSource` + // is fixed at init — so every PageCoordinator must be built with `pages:` or `dataSource:` below. + + /// + /// Creates a PageCoordinator with several sequential (potentially looping) pages. + /// + /// If neither `firstPage` nor `secondPage` is specified, the coordinator falls back to showing the + /// first one or two of `pages` (depending on whether the page view controller is double-sided). + /// + /// - Parameters: + /// - rootViewController: The `UIPageViewController` to host pages. Defaults to a fresh instance. + /// Note that you cannot change its transition style / navigation orientation / options after + /// initialization — use the convenience initializer to configure those up front. + /// - pages: The pages of the PageCoordinator. These can be changed later via ``dataSource``. + /// - loop: Whether the coordinator should loop when reaching the end or the beginning of `pages`. + /// - firstPage: The page to show on appearance. Must be an element of `pages`. If `nil`, falls back + /// to the first page (or first two for double-sided controllers). + /// - secondPage: The second page when the page view controller is double-sided. Optional. + /// - direction: Animation direction for the initial set transition. Ignored if no initial page is set. + /// + public init(rootViewController: RootViewController = .init(), + pages: [Presentable], + loop: Bool = false, + set firstPage: (any Presentable)? = nil, + _ secondPage: (any Presentable)? = nil, + direction: UIPageViewController.NavigationDirection = .forward) { + self.dataSource = PageCoordinatorDataSource(pages: pages.map { $0.viewController }, loop: loop) + rootViewController.dataSource = dataSource + + let setInitialPages = [firstPage, secondPage].compactMap { $0 } + let initialPages = setInitialPages.isEmpty ? Array(pages.prefix(rootViewController.isDoubleSided ? 2 : 1)) : setInitialPages + guard let firstPage = initialPages.first else { + assertionFailure("Please provide a positive number of pages for use in \(String(describing: PageCoordinator.self))") + super.init(rootViewController: rootViewController, initialTransition: .initial(pages: pages)) + return + } + + super.init(rootViewController: rootViewController, + initialTransition: .multiple(.initial(pages: pages), .set(firstPage, initialPages.count > 1 ? initialPages[1] : nil, direction: direction))) + } + + /// + /// Creates a PageCoordinator with a custom dataSource. + /// + /// - Parameters: + /// - rootViewController: The `UIPageViewController` to host pages. Defaults to a fresh instance. + /// - dataSource: The dataSource to drive page navigation. + /// - firstPage: The page to show on appearance. + /// - secondPage: The second page when the page view controller is double-sided. Optional. + /// - direction: Animation direction for the initial set transition. + /// + public init(rootViewController: RootViewController = .init(), + dataSource: UIPageViewControllerDataSource, + set firstPage: any Presentable, + _ secondPage: (any Presentable)? = nil, + direction: UIPageViewController.NavigationDirection) { + self.dataSource = dataSource + rootViewController.dataSource = dataSource + super.init(rootViewController: rootViewController, + initialTransition: .set(firstPage, secondPage, direction: direction)) + } + + /// + /// Creates a PageCoordinator and its underlying `UIPageViewController` up front, letting you configure + /// the controller's transition style, orientation, double-sided mode, spine location, and inter-page spacing. + /// + /// - Parameters: + /// - transitionStyle: The style used to transition between pages. + /// - navigationOrientation: Horizontal or vertical page navigation. + /// - isDoubleSided: Whether the page view controller renders two pages at once. + /// - spineLocation: The spine location for double-sided controllers. Defaults to `.mid` when + /// `isDoubleSided` is true and `nil` otherwise. + /// - interPageSpacing: The spacing between adjacent pages. + /// - pages: The pages of the PageCoordinator. + /// - loop: Whether the coordinator should loop at the end and the beginning of `pages`. + /// - firstPage: The page to show on appearance. See ``init(rootViewController:pages:loop:set:_:direction:)`` + /// for the fallback behaviour when `firstPage` is `nil`. + /// - secondPage: The second page when `isDoubleSided` is true. Optional. + /// - direction: Animation direction for the initial set transition. + public convenience init( + transitionStyle: UIPageViewController.TransitionStyle = .pageCurl, + navigationOrientation: UIPageViewController.NavigationOrientation = .horizontal, + isDoubleSided: Bool = false, + spineLocation: UIPageViewController.SpineLocation? = nil, + interPageSpacing: CGFloat? = nil, + pages: [any Presentable], + loop: Bool = false, + set firstPage: (any Presentable)? = nil, + _ secondPage: (any Presentable)? = nil, + direction: UIPageViewController.NavigationDirection = .forward + ) { + var options = [UIPageViewController.OptionsKey: Any]() + options[.spineLocation] = (spineLocation ?? (isDoubleSided ? .mid : nil))?.rawValue + options[.interPageSpacing] = interPageSpacing + + let rootViewController = UIPageViewController( + transitionStyle: transitionStyle, + navigationOrientation: navigationOrientation, + options: options.isEmpty ? nil : options + ) + rootViewController.isDoubleSided = isDoubleSided + + self.init( + rootViewController: rootViewController, + pages: pages, + loop: loop, + set: firstPage, + secondPage, + direction: direction + ) + } + +} diff --git a/Sources/XCoordinator/PageCoordinatorDataSource.swift b/Sources/XCoordinator/Page/PageCoordinatorDataSource.swift similarity index 100% rename from Sources/XCoordinator/PageCoordinatorDataSource.swift rename to Sources/XCoordinator/Page/PageCoordinatorDataSource.swift diff --git a/Sources/XCoordinator/PageTransition.swift b/Sources/XCoordinator/Page/PageTransition.swift similarity index 56% rename from Sources/XCoordinator/PageTransition.swift rename to Sources/XCoordinator/Page/PageTransition.swift index e8b4c19b..6827ff61 100755 --- a/Sources/XCoordinator/PageTransition.swift +++ b/Sources/XCoordinator/Page/PageTransition.swift @@ -1,5 +1,5 @@ // -// PageViewTransition.swift +// PageTransition.swift // XCoordinator // // Created by Paul Kraft on 29.07.18. @@ -28,23 +28,35 @@ extension Transition where RootViewController: UIPageViewController { /// - direction: /// The direction in which the transition should be animated. /// - public static func set(_ first: Presentable, _ second: Presentable? = nil, + public static func set(_ first: any Presentable, _ second: (any Presentable)? = nil, direction: UIPageViewController.NavigationDirection) -> Transition { let presentables = [first, second].compactMap { $0 } - return Transition(presentables: presentables, - animationInUse: nil - ) { rootViewController, options, completion in - rootViewController.set(presentables.map { $0.viewController }, - direction: direction, - with: options - ) { + return Transition(presentables: presentables, animationInUse: nil) { rootViewController, options, completion in + let viewControllers: [UIViewController] = presentables.map { $0.viewController } + rootViewController.isDoubleSided = viewControllers.count > 1 + + // `UIPageViewController.setViewControllers(_:direction:animated:completion:)` skips its completion + // block when asked to display the pages it is already showing (a long-standing UIKit quirk). + // `deepLink` chains the next route inside this completion, so short-circuit the no-op case and + // invoke the completion ourselves to keep chained transitions flowing. `presented(from:)` already + // fired when these pages were first set, so it is not repeated here. + guard rootViewController.viewControllers != viewControllers else { + completion?() + return + } + + rootViewController.setViewControllers( + viewControllers, + direction: direction, + animated: options.animated + ) { _ in presentables.forEach { $0.presented(from: rootViewController) } completion?() } } } - static func initial(pages: [Presentable]) -> Transition { + static func initial(pages: [any Presentable]) -> Transition { Transition(presentables: pages, animationInUse: nil) { rootViewController, _, completion in CATransaction.begin() CATransaction.setCompletionBlock { @@ -54,4 +66,5 @@ extension Transition where RootViewController: UIPageViewController { CATransaction.commit() } } + } diff --git a/Sources/XCoordinator/PageCoordinator.swift b/Sources/XCoordinator/PageCoordinator.swift deleted file mode 100755 index 4999f70a..00000000 --- a/Sources/XCoordinator/PageCoordinator.swift +++ /dev/null @@ -1,101 +0,0 @@ -// -// PageCoordinator.swift -// XCoordinator -// -// Created by Paul Kraft on 30.07.18. -// Copyright © 2018 QuickBird Studios. All rights reserved. -// - -import UIKit - -/// -/// PageCoordinator provides a base class for your custom coordinator with a `UIPageViewController` rootViewController. -/// -/// - Note: -/// PageCoordinator sets the dataSource of the rootViewController to reflect the parameters in the initializer. -/// -open class PageCoordinator: BaseCoordinator { - - // MARK: Stored properties - - /// - /// The dataSource of the rootViewController. - /// - /// Feel free to change the pages at runtime. To reflect the changes in the rootViewController, perform a `set` transition as well. - /// - public let dataSource: UIPageViewControllerDataSource - - // MARK: Initialization - - /// - /// Creates a PageCoordinator with several sequential (potentially looping) pages. - /// - /// It further sets the current page of the rootViewController animated in the specified direction. - /// - /// - Note: - /// If you need custom configuration of the rootViewController, modify the `configuration` parameter, - /// since you cannot change this after the initialization. - /// - /// - Parameters: - /// - pages: - /// The pages of the PageCoordinator. - /// These can be changed later, if necessary, using the `PageCoordinator.dataSource` property. - /// - loop: - /// Whether or not the PageCoordinator should loop when hitting the end or the beginning of the specified pages. - /// - set: - /// The presentable to be shown right from the start. - /// This should be one of the elements of the specified pages. - /// If not specified, no `set` transition is triggered, which results in the first page being shown. - /// - direction: - /// The direction in which the transition to set the specified first page (parameter `set`) should be animated in. - /// If you specify `nil` for `set`, this parameter is ignored. - /// - configuration: - /// The configuration of the rootViewController. You cannot change this configuration later anymore (Limitation of UIKit). - /// - public init(rootViewController: RootViewController = .init(), - pages: [Presentable], - loop: Bool = false, - set: Presentable? = nil, - direction: UIPageViewController.NavigationDirection = .forward) { - self.dataSource = PageCoordinatorDataSource(pages: pages.map { $0.viewController }, loop: loop) - rootViewController.dataSource = dataSource - - guard let firstPage = set ?? pages.first else { - assertionFailure("Please provide a positive number of pages for use in \(String(describing: PageCoordinator.self))") - super.init(rootViewController: rootViewController, initialTransition: .initial(pages: pages)) - return - } - - super.init(rootViewController: rootViewController, - initialTransition: .multiple(.initial(pages: pages), .set(firstPage, direction: direction))) - } - - /// - /// Creates a PageCoordinator with a custom dataSource. - /// It further sets the currently shown page and a direction for the animation of displaying it. - /// If you need custom configuration of the rootViewController, modify the `configuration` parameter, - /// since you cannot change this after the initialization. - /// - /// - Parameters: - /// - dataSource: - /// The dataSource of the PageCoordinator. - /// - set: - /// The presentable to be shown right from the start. - /// This should be one of the elements of the specified pages. - /// If not specified, no `set` transition is triggered, which results in the first page being shown. - /// - direction: - /// The direction in which the transition to set the specified first page (parameter `set`) should be animated in. - /// If you specify `nil` for `set`, this parameter is ignored. - /// - configuration: - /// The configuration of the rootViewController. You cannot change this configuration later anymore (Limitation of UIKit). - /// - public init(rootViewController: RootViewController = .init(), - dataSource: UIPageViewControllerDataSource, - set: Presentable, - direction: UIPageViewController.NavigationDirection) { - self.dataSource = dataSource - rootViewController.dataSource = dataSource - super.init(rootViewController: rootViewController, - initialTransition: .set(set, direction: direction)) - } -} diff --git a/Sources/XCoordinator/Split/SplitCoordinator.swift b/Sources/XCoordinator/Split/SplitCoordinator.swift new file mode 100755 index 00000000..5a8c804f --- /dev/null +++ b/Sources/XCoordinator/Split/SplitCoordinator.swift @@ -0,0 +1,82 @@ +// +// SplitCoordinator.swift +// XCoordinator +// +// Created by Paul Kraft on 30.07.18. +// Copyright © 2018 QuickBird Studios. All rights reserved. +// + +import UIKit + +/// +/// SplitCoordinator can be used as a basis for a coordinator with a rootViewController of type +/// `UISplitViewController`. +/// +/// You can use all `SplitTransitions` and get an initializer to set a master and +/// (optional) detail presentable. +/// +open class SplitCoordinator: BaseCoordinator { + + // MARK: Initialization + + /// + /// Creates a SplitCoordinator and optionally triggers an initial route. + /// + /// - Parameters: + /// - rootViewController: The `UISplitViewController` to host transitions. Defaults to a fresh instance. + /// - initialRoute: A route to trigger once the coordinator is shown. + public override init(rootViewController: RootViewController = .init(), initialRoute: RouteType?) { + super.init(rootViewController: rootViewController, initialRoute: initialRoute) + } + + /// + /// Creates a SplitCoordinator and optionally performs an initial transition. + /// + /// - Parameters: + /// - rootViewController: The `UISplitViewController` to host transitions. + /// - initialTransition: A transition to perform once the coordinator is shown. Pass `nil` to skip. + public override init(rootViewController: RootViewController, initialTransition: SplitTransition?) { + super.init(rootViewController: rootViewController, initialTransition: initialTransition) + } + + /// + /// Creates a SplitCoordinator and performs an initial transition described with the transition builder. + /// + /// - Parameters: + /// - rootViewController: The `UISplitViewController` to host transitions. + /// - initialTransition: A transition-builder closure describing the transition to perform. + public override init(rootViewController: RootViewController, + @TransitionBuilder initialTransition: () -> SplitTransition) { + super.init(rootViewController: rootViewController, initialTransition: initialTransition()) + } + + /// + /// Creates a SplitCoordinator and sets the specified presentables as the split controller's view controllers. + /// + /// - Parameters: + /// - rootViewController: The `UISplitViewController` to host transitions. Defaults to a fresh instance. + /// - primary: The presentable shown in the primary column. + /// - secondary: The presentable shown in the secondary (detail) column. Optional, because a small-screen + /// device may not want to show a detail right away. + /// - supplementary: The presentable shown in the supplementary column. Optional. When provided, + /// each column is set individually via the triple-column API, so `rootViewController` must be a + /// triple-column split controller (`UISplitViewController(style: .tripleColumn)`); otherwise the + /// supplementary column is ignored by UIKit. + /// + public init(rootViewController: RootViewController = .init(), primary: any Presentable, secondary: (any Presentable)?, supplementary: (any Presentable)? = nil) { + if let supplementary { + // Use the per-column API so the supplementary column is actually populated + // (assigning `viewControllers` only honors primary + secondary on a legacy split). + super.init(rootViewController: rootViewController, + initialTransition: .multiple( + .set(primary, for: .primary), + .set(secondary, for: .secondary), + .set(supplementary, for: .supplementary) + )) + } else { + super.init(rootViewController: rootViewController, + initialTransition: .set([primary, secondary].compactMap { $0 })) + } + } + +} diff --git a/Sources/XCoordinator/Split/SplitTransition.swift b/Sources/XCoordinator/Split/SplitTransition.swift new file mode 100755 index 00000000..6c2371cd --- /dev/null +++ b/Sources/XCoordinator/Split/SplitTransition.swift @@ -0,0 +1,57 @@ +// +// SplitTransition.swift +// XCoordinator +// +// Created by Paul Kraft on 10.01.19. +// Copyright © 2018 QuickBird Studios. All rights reserved. +// + +import UIKit + +/// +/// SplitTransition offers different transitions common to a `UISplitViewController` rootViewController. +/// +public typealias SplitTransition = Transition + +extension Transition where RootViewController: UISplitViewController { + + /// + /// Replaces the split view controller's `viewControllers` with the given presentables. + /// + /// - Parameter presentables: The presentables that become the split controller's columns, in order. + public static func set(_ presentables: [any Presentable]) -> Transition { + Transition(presentables: presentables, animationInUse: nil) { rootViewController, _, completion in + CATransaction.begin() + CATransaction.setCompletionBlock { + presentables.forEach { $0.presented(from: rootViewController) } + completion?() + } + autoreleasepool { + rootViewController.viewControllers = presentables.map { $0.viewController } + } + CATransaction.commit() + } + } + + /// + /// Sets a single presentable into the given `UISplitViewController.Column` (iOS 14+ triple-column API). + /// + /// - Parameters: + /// - presentable: The presentable for the column. Pass `nil` to clear the column. + /// - column: The column to set. + @available(iOS 14, *) + public static func set(_ presentable: (any Presentable)?, for column: UISplitViewController.Column) -> Transition { + Transition(presentables: [presentable].compactMap { $0 }, animationInUse: nil) { rootViewController, _, completion in + CATransaction.begin() + CATransaction.setCompletionBlock { + presentable?.presented(from: rootViewController) + completion?() + } + autoreleasepool { + rootViewController.setViewController(presentable?.viewController, for: column) + } + CATransaction.commit() + } + } + +} diff --git a/Sources/XCoordinator/SplitCoordinator.swift b/Sources/XCoordinator/SplitCoordinator.swift deleted file mode 100755 index dfe050c6..00000000 --- a/Sources/XCoordinator/SplitCoordinator.swift +++ /dev/null @@ -1,39 +0,0 @@ -// -// SplitCoordinator.swift -// XCoordinator -// -// Created by Paul Kraft on 30.07.18. -// Copyright © 2018 QuickBird Studios. All rights reserved. -// - -/// -/// SplitCoordinator can be used as a basis for a coordinator with a rootViewController of type -/// `UISplitViewController`. -/// -/// You can use all `SplitTransitions` and get an initializer to set a master and -/// (optional) detail presentable. -/// -open class SplitCoordinator: BaseCoordinator { - - // MARK: Initialization - - public override init(rootViewController: RootViewController = .init(), initialRoute: RouteType?) { - super.init(rootViewController: rootViewController, initialRoute: initialRoute) - } - - /// - /// Creates a SplitCoordinator and sets the specified presentables as the rootViewController's - /// viewControllers. - /// - /// - Parameters: - /// - master: - /// The presentable to be shown as master in the `UISplitViewController`. - /// - detail: - /// The presentable to be shown as detail in the `UISplitViewController`. This is optional due to - /// the fact that it might not be useful to have a detail page right away on a small-screen device. - /// - public init(rootViewController: RootViewController = .init(), master: Presentable, detail: Presentable?) { - super.init(rootViewController: rootViewController, - initialTransition: .set([master, detail].compactMap { $0 })) - } -} diff --git a/Sources/XCoordinator/SplitTransition.swift b/Sources/XCoordinator/SplitTransition.swift deleted file mode 100755 index 02018a38..00000000 --- a/Sources/XCoordinator/SplitTransition.swift +++ /dev/null @@ -1,32 +0,0 @@ -// -// UISplitViewController+Transition.swift -// XCoordinator -// -// Created by Paul Kraft on 10.01.19. -// Copyright © 2018 QuickBird Studios. All rights reserved. -// - -import UIKit - -/// -/// SplitTransition offers different transitions common to a `UISplitViewController` rootViewController. -/// -public typealias SplitTransition = Transition - -extension Transition where RootViewController: UISplitViewController { - - public static func set(_ presentables: [Presentable]) -> Transition { - Transition(presentables: presentables, animationInUse: nil) { rootViewController, _, completion in - CATransaction.begin() - CATransaction.setCompletionBlock { - presentables.forEach { $0.presented(from: rootViewController) } - completion?() - } - autoreleasepool { - rootViewController.viewControllers = presentables.map { $0.viewController } - } - CATransaction.commit() - } - } - -} diff --git a/Sources/XCoordinator/StrongRouter.swift b/Sources/XCoordinator/StrongRouter.swift deleted file mode 100755 index b26cfa39..00000000 --- a/Sources/XCoordinator/StrongRouter.swift +++ /dev/null @@ -1,119 +0,0 @@ -// -// StrongRouter.swift -// XCoordinator -// -// Created by Paul Kraft on 28.07.18. -// Copyright © 2018 QuickBird Studios. All rights reserved. -// - -import UIKit - -/// -/// StrongRouter is a type-erasure of a given Router object and, therefore, can be used as an abstraction from a specific Router -/// implementation without losing type information about its RouteType. -/// -/// StrongRouter abstracts away any implementation specific details and -/// essentially reduces them to properties specified in the `Router` protocol. -/// -/// - Note: -/// Do not hold a reference to any router from the view hierarchy. -/// Use `UnownedRouter` or `WeakRouter` in your view controllers or view models instead. -/// You can create them using the `Coordinator.unownedRouter` and `Coordinator.weakRouter` properties. -/// -public final class StrongRouter: Router { - - // MARK: Stored properties - - private let _contextTrigger: (RouteType, TransitionOptions, ContextPresentationHandler?) -> Void - private let _trigger: (RouteType, TransitionOptions, PresentationHandler?) -> Void - private let _presented: (Presentable?) -> Void - private let _viewController: () -> UIViewController? - private let _setRoot: (UIWindow) -> Void - private let _registerParent: (Presentable & AnyObject) -> Void - private let _childTransitionCompleted: () -> Void - - // MARK: Initialization - - /// - /// Creates a StrongRouter object from a given router. - /// - /// - Parameter router: - /// The source router. - /// - public init(_ router: T) where T.RouteType == RouteType { - _trigger = router.trigger - _presented = router.presented - _viewController = { router.viewController } - _setRoot = router.setRoot - _contextTrigger = router.contextTrigger - _registerParent = router.registerParent - _childTransitionCompleted = router.childTransitionCompleted - } - - // MARK: Public methods - - /// - /// Triggers routes and provides the transition context in the completion-handler. - /// - /// Useful for deep linking. It is encouraged to use `trigger` instead, if the context is not needed. - /// - /// - Parameters: - /// - route: The route to be triggered. - /// - options: Transition options configuring the execution of transitions, e.g. whether it should be animated. - /// - completion: - /// If present, this completion handler is executed once the transition is completed - /// (including animations). - /// If the context is not needed, use `trigger` instead. - /// - public func contextTrigger(_ route: RouteType, - with options: TransitionOptions, - completion: ContextPresentationHandler?) { - _contextTrigger(route, options, completion) - } - - /// - /// Triggers the specified route by performing a transition. - /// - /// - Parameters: - /// - route: The route to be triggered. - /// - options: Transition options for performing the transition, e.g. whether it should be animated. - /// - completion: - /// If present, this completion handler is executed once the transition is completed - /// (including animations). - /// - public func trigger(_ route: RouteType, with options: TransitionOptions, completion: PresentationHandler?) { - _trigger(route, options, completion) - } - - /// - /// This method is called whenever a Presentable is shown to the user. - /// It further provides information about the presentable responsible for the presenting. - /// - /// - Parameter presentable: - /// The context in which the presentable is shown. - /// This could be a window, another viewController, a coordinator, etc. - /// `nil` is specified whenever a context cannot be easily determined. - /// - public func presented(from presentable: Presentable?) { - _presented(presentable) - } - - /// - /// The viewController of the Presentable. - /// - /// In the case of a `UIViewController`, it returns itself. - /// A coordinator returns its rootViewController. - /// - public var viewController: UIViewController! { - _viewController() - } - - public func registerParent(_ presentable: Presentable & AnyObject) { - _registerParent(presentable) - } - - public func childTransitionCompleted() { - _childTransitionCompleted() - } - -} diff --git a/Sources/XCoordinator/SwiftUI/Representable.swift b/Sources/XCoordinator/SwiftUI/Representable.swift new file mode 100644 index 00000000..850d10c2 --- /dev/null +++ b/Sources/XCoordinator/SwiftUI/Representable.swift @@ -0,0 +1,50 @@ +// +// Representable.swift +// XCoordinator +// +// Created by Paul Johannes Kraft (QB) on 15.05.25. +// Copyright © 2018 QuickBird Studios. All rights reserved. +// + +#if canImport(SwiftUI) + +import SwiftUI + +internal struct Representable: UIViewControllerRepresentable { + // MARK: Stored Properties + + private let create: () -> C + private let update: (UIViewController, Context) -> Void + + // MARK: Initialization + + internal init( + create: @escaping () -> C, + update: @escaping (UIViewController, Context) -> Void = { _, _ in } + ) { + self.create = create + self.update = update + } + + // MARK: Methods + + internal func makeCoordinator() -> C { + create() + } + + internal func makeUIViewController( + context: Context + ) -> UIViewController { + context.coordinator.viewController + } + + internal func updateUIViewController( + _ controller: UIViewController, + context: Context + ) { + update(controller, context) + } + +} + +#endif diff --git a/Sources/XCoordinator/SwiftUI/RepresentableContext.swift b/Sources/XCoordinator/SwiftUI/RepresentableContext.swift new file mode 100644 index 00000000..49dc025e --- /dev/null +++ b/Sources/XCoordinator/SwiftUI/RepresentableContext.swift @@ -0,0 +1,59 @@ +// +// RepresentableContext.swift +// XCoordinator +// +// Created by Paul Johannes Kraft (QB) on 20.05.25. +// Copyright © 2018 QuickBird Studios. All rights reserved. +// + +#if canImport(SwiftUI) + +import SwiftUI +import UIKit + +/// +/// A common abstraction over the SwiftUI representable contexts. +/// +/// Both `UIViewControllerRepresentableContext` and `UIViewRepresentableContext` conform to +/// `RepresentableContext`, which lets callers handle either context type with the same code path. +/// +@MainActor +public protocol RepresentableContext { + + /// The representable's coordinator instance. + associatedtype Coordinator = Void + + /// The coordinator instance produced by `makeCoordinator()`. + var coordinator: Coordinator { get } + + /// The current SwiftUI transaction associated with this update. + var transaction: Transaction { get } + + /// The SwiftUI environment values at the point of this update. + var environment: EnvironmentValues { get } + + /// + /// Runs the given changes inside a SwiftUI animation, calling the completion handler when it finishes. + /// + /// This bridges the iOS 18 `animate(changes:completion:)` API onto the representable contexts + /// so that callers can use it uniformly via the protocol. + /// + /// - Parameters: + /// - changes: The state mutations to animate. + /// - completion: A closure invoked once the animation has completed. + /// + @available(iOS 18.0, tvOS 18.0, visionOS 2.0, *) + @available(macOS, unavailable) + @available(watchOS, unavailable) + func animate(changes: () -> Void, completion: (() -> Void)?) +} + +extension UIViewControllerRepresentableContext: RepresentableContext { + public typealias Coordinator = Representable.Coordinator +} + +extension UIViewRepresentableContext: RepresentableContext { + public typealias Coordinator = Representable.Coordinator +} + +#endif diff --git a/Sources/XCoordinator/SwiftUI/Routing.swift b/Sources/XCoordinator/SwiftUI/Routing.swift new file mode 100644 index 00000000..d51a8e55 --- /dev/null +++ b/Sources/XCoordinator/SwiftUI/Routing.swift @@ -0,0 +1,79 @@ +// +// Routing.swift +// XCoordinator +// +// Created by Paul Kraft on 08.05.23. +// Copyright © 2023 QuickBird Studios. All rights reserved. +// + +#if canImport(SwiftUI) + +import SwiftUI + +/// +/// A property wrapper that resolves the nearest `Router` for a given `Route` type from the SwiftUI environment. +/// +/// Use `@Routing` inside a SwiftUI view to access the router responsible for a particular flow. +/// The wrapped value is non-optional — if no matching router is in scope, accessing it triggers a `fatalError`, +/// because that is a programmer error rather than a runtime condition. +/// +/// ```swift +/// struct ChildView: View { +/// @Routing var usersRouter +/// +/// var body: some View { +/// Button("Open") { usersRouter.trigger(.user("Bob")) } +/// } +/// } +/// ``` +/// +/// The projected value exposes the full ``RoutingContext`` for advanced lookups via `$router[OtherRoute.self]`. +/// +@MainActor +@propertyWrapper +public struct Routing: DynamicProperty { + + // MARK: Stored Properties + + @Environment(\.routingContext) private var routingContext + + // MARK: Computed Properties + + /// The router responsible for `RouteType` in the current environment. + /// + /// - Important: Triggers `fatalError` if no router for `RouteType` was registered upstream. Make sure + /// the view is hosted within a ``RoutingController``, ``WrappedRouter``, or a `View.router(_:)` modifier + /// that provides a matching router. + public var wrappedValue: any Router { + guard let router = routingContext[RouteType.self] else { + fatalError(""" + The current environment does not contain a router with the route type of \"\(RouteType.self)\". + Please make sure to specify the correct route type when using this property wrapper. + """) + } + return router + } + + /// The full ``RoutingContext``, allowing access to routers for other route types via subscript. + public var projectedValue: RoutingContext { + routingContext + } + + // MARK: Initialization + + /// Creates a property wrapper that resolves a router for the given route type. + public init(_ routeType: RouteType.Type = RouteType.self) {} + + // MARK: Methods + + /// Looks up a router for a different route type in the same environment. + /// + /// - Parameter for: The route type to search for. + /// - Returns: The router for the given route type, or `nil` if no router is registered upstream. + public func router(for: R.Type) -> (any Router)? { + routingContext[R.self] + } + +} + +#endif diff --git a/Sources/XCoordinator/SwiftUI/RoutingContext.swift b/Sources/XCoordinator/SwiftUI/RoutingContext.swift new file mode 100644 index 00000000..894e4914 --- /dev/null +++ b/Sources/XCoordinator/SwiftUI/RoutingContext.swift @@ -0,0 +1,135 @@ +// +// RoutingContext.swift +// XCoordinator +// +// Created by Paul Kraft on 08.05.23. +// Copyright © 2023 QuickBird Studios. All rights reserved. +// + +#if canImport(SwiftUI) + +import SwiftUI + +/// +/// A registry of `Router` instances keyed by their `Route` type, propagated through the SwiftUI environment. +/// +/// `RoutingContext` carries one router per route type so that `@Routing` can resolve the +/// appropriate router for any flow currently in scope. It is propagated two ways simultaneously: +/// +/// - **Down** through `EnvironmentValues.routingContext`, so descendants can read the available routers. +/// - **Up** through a `SwiftUI.PreferenceKey`, so hosts (e.g. ``RoutingController``) can observe routers +/// registered deeper in the view tree and merge them back into their own context. +/// +public struct RoutingContext: Equatable { + + // MARK: Static Functions + + /// Two routing contexts are considered equal when they contain the same router instances + /// (compared by `ObjectIdentifier`) keyed by the same route types. Deallocated routers compare + /// as `nil`, so a context whose router has gone away is no longer equal to one that still holds it. + public static func == (lhs: RoutingContext, rhs: RoutingContext) -> Bool { + return lhs.routers.mapValues { $0.router.map(ObjectIdentifier.init) } + == rhs.routers.mapValues { $0.router.map(ObjectIdentifier.init) } + } + + // MARK: Nested Types + + /// Holds a router weakly so that a `RoutingContext` does not keep routers alive. Every router + /// registered here is owned elsewhere (a parent coordinator's `children`, `WrappedRouter.Holder`, + /// or a `RouterModifier`), so a strong reference would only create retain cycles. + private struct WeakRouter { + weak var router: (any Router)? + } + + fileprivate enum EnvironmentKey: SwiftUI.EnvironmentKey { + static var defaultValue: RoutingContext { RoutingContext() } + } + + fileprivate enum PreferenceKey: SwiftUI.PreferenceKey { + static var defaultValue: RoutingContext { RoutingContext() } + + static func reduce(value: inout RoutingContext, nextValue: () -> RoutingContext) { + value.add(nextValue()) + } + } + + // MARK: Properties + + private var routers = [ObjectIdentifier: WeakRouter]() + + // MARK: Initialization + + /// Creates an empty routing context. + public nonisolated init() {} + + /// Creates a routing context pre-populated with the given routers. + /// + /// - Parameter routers: Routers to register. Each is keyed by its concrete `RouteType`. + public init(_ routers: [any Router] = []) { + for router in routers { + add(router) + } + } + + // MARK: Subscripts + + /// Reads or writes the router responsible for the given route type. + /// + /// Each router is stored keyed by its own `RouteType`, so casting the stored router to + /// `any Router` for that same key is equivalent to `router(for:)` — and avoids calling the + /// main-actor-isolated `router(for:)`, keeping this type free of actor isolation. + public subscript(_ routeType: R.Type) -> (any Router)? { + get { routers[ObjectIdentifier(routeType)]?.router as? any Router } + set { + if let newValue { + routers[ObjectIdentifier(routeType)] = WeakRouter(router: newValue) + } else { + routers[ObjectIdentifier(routeType)] = nil + } + } + } + + // MARK: Methods + + /// Registers a router under its declared `RouteType`. Replaces any existing router for that type. + public mutating func add(_ router: any Router) { + router.add(to: &self) + } + + internal mutating func add(_ context: RoutingContext) { + for (key, value) in context.routers { + routers[key] = value + } + } + +} + +extension Router { + // `nonisolated` overrides the `@MainActor` isolation inherited from the `Router` protocol: this only + // stores a reference via the (nonisolated) subscript setter, so it needs no actor isolation and keeps + // `RoutingContext` free of `@MainActor`. + fileprivate nonisolated func add(to context: inout RoutingContext) { + context[RouteType.self] = self + } +} + +extension View { + internal func onRoutingContextChanged(perform: @escaping (RoutingContext) -> Void) -> some View { + onPreferenceChange(RoutingContext.PreferenceKey.self) { + perform($0) + } + } + + internal func routingContext(_ context: RoutingContext) -> some View { + preference(key: RoutingContext.PreferenceKey.self, value: context) + } +} + +extension EnvironmentValues { + internal var routingContext: RoutingContext { + get { self[RoutingContext.EnvironmentKey.self] } + set { self[RoutingContext.EnvironmentKey.self] = newValue } + } +} + +#endif diff --git a/Sources/XCoordinator/SwiftUI/RoutingContextProvider.swift b/Sources/XCoordinator/SwiftUI/RoutingContextProvider.swift new file mode 100644 index 00000000..4df2d884 --- /dev/null +++ b/Sources/XCoordinator/SwiftUI/RoutingContextProvider.swift @@ -0,0 +1,25 @@ +// +// RoutingContextProvider.swift +// XCoordinator +// +// Created by Paul Kraft on 09.05.2025. +// Copyright © 2018 QuickBird Studios. All rights reserved. +// + +#if canImport(SwiftUI) + +/// +/// A type that exposes a writable ``RoutingContext`` for downstream propagation through the SwiftUI environment. +/// +/// Conforming types (such as ``RoutingController``) participate in the routing-context machinery used by +/// `Coordinator.performTransition`: when a transition produces presentables that conform to this protocol, +/// the coordinator registers itself in their `routingContext` so that descendant SwiftUI views can resolve +/// the coordinator via `@Routing`. +/// +public protocol RoutingContextProvider { + + /// The routing context provided to the SwiftUI environment. + var routingContext: RoutingContext { get nonmutating set } +} + +#endif diff --git a/Sources/XCoordinator/SwiftUI/RoutingController.swift b/Sources/XCoordinator/SwiftUI/RoutingController.swift new file mode 100644 index 00000000..7d7a6f8e --- /dev/null +++ b/Sources/XCoordinator/SwiftUI/RoutingController.swift @@ -0,0 +1,144 @@ +// +// RoutingController.swift +// XCoordinator +// +// Created by Paul Kraft on 08.05.23. +// Copyright © 2023 QuickBird Studios. All rights reserved. +// + +#if canImport(SwiftUI) + +import SwiftUI + +/// +/// An observable wrapper around a ``RoutingContext`` so that updates made after a +/// ``RoutingController`` has been created (e.g. a coordinator registering itself during +/// `performTransition`, or routers merged back up through a `PreferenceKey`) are re-injected +/// into the hosted SwiftUI environment. +/// +/// `RoutingContext` is a value type, so storing it in a plain property captures a snapshot. +/// Routing every mutation through this reference type lets SwiftUI observe the change and +/// re-evaluate the injecting view. +/// +@MainActor +internal final class RoutingContextBox: ObservableObject { + @Published var context: RoutingContext + + init(_ context: RoutingContext) { + self.context = context + } +} + +/// +/// A `UIHostingController` subclass that bridges a SwiftUI view tree into a UIKit coordinator flow. +/// +/// `RoutingController` is the SwiftUI counterpart to ``ViewCoordinator``'s root view controller: it injects +/// a ``RoutingContext`` into its hosted view's environment, and observes context updates flowing back up +/// through a `PreferenceKey` so that descendant views can register additional routers. +/// +/// Use it from `prepareTransition(for:)` to push or present SwiftUI content from a UIKit coordinator: +/// +/// ```swift +/// return .push(RoutingController { UserView(name: name) }) +/// ``` +/// +public class RoutingController: UIHostingController.InjectorView>, RoutingContextProvider { + + // MARK: Nested Types + + /// The internal SwiftUI wrapper view that injects the routing context and listens for downstream changes. + /// + /// This type is only public because it must appear in the `UIHostingController`'s generic parameter list. + /// Treat it as an implementation detail; do not construct or inspect it directly. + public struct InjectorView: View { + + // MARK: Stored Properties + + @ObservedObject private var box: RoutingContextBox + private let content: Content + private let onUpdate: (RoutingContext) -> Void + + // MARK: Computed Properties + + public var body: some View { + content + .environment(\.routingContext, box.context) + .onRoutingContextChanged(perform: onUpdate) + } + + // MARK: Initialization + + fileprivate init( + box: RoutingContextBox, + content: Content, + onUpdate: @escaping (RoutingContext) -> Void + ) { + self._box = ObservedObject(wrappedValue: box) + self.content = content + self.onUpdate = onUpdate + } + + } + + // MARK: Properties + + private let box: RoutingContextBox + + /// The routing context currently propagated into the hosted SwiftUI environment. + /// + /// Mutating it (e.g. via `routingContext.add(_:)`) re-injects the updated context into the + /// hosted SwiftUI environment, so descendant `@Routing` lookups resolve against the latest routers. + public var routingContext: RoutingContext { + get { box.context } + set { box.context = newValue } + } + + // MARK: Initialization + + /// + /// Creates a routing controller that hosts the given SwiftUI view. + /// + /// - Parameters: + /// - context: The initial routing context to inject into the environment. Defaults to an empty context; + /// the surrounding coordinator typically populates it via `performTransition`. + /// - rootView: The SwiftUI view to host. + /// + public init( + context: RoutingContext = .init(), + rootView: Content + ) { + let box = RoutingContextBox(context) + self.box = box + super.init( + rootView: InjectorView( + box: box, + content: rootView + ) { [box] updatedContext in + // Merge routers flowing UP via the PreferenceKey back into the injected context. + box.context.add(updatedContext) + } + ) + } + + /// + /// Creates a routing controller that hosts a SwiftUI view built with a `@ViewBuilder` closure. + /// + /// - Parameters: + /// - context: The initial routing context. Defaults to an empty context. + /// - rootView: The view-builder producing the hosted SwiftUI content. + /// + public convenience init( + context: RoutingContext = .init(), + @ViewBuilder rootView: () -> Content + ) { + self.init(context: context, rootView: rootView()) + } + + public required init?(coder aDecoder: NSCoder) { + self.box = RoutingContextBox(.init()) + super.init(coder: aDecoder) + } + +} + +#endif diff --git a/Sources/XCoordinator/SwiftUI/Transition+SwiftUI.swift b/Sources/XCoordinator/SwiftUI/Transition+SwiftUI.swift new file mode 100644 index 00000000..22230bcd --- /dev/null +++ b/Sources/XCoordinator/SwiftUI/Transition+SwiftUI.swift @@ -0,0 +1,102 @@ +// +// Transition+SwiftUI.swift +// XCoordinator +// +// Created by Paul Johannes Kraft (QB) on 12.05.25. +// Copyright © 2018 QuickBird Studios. All rights reserved. +// + +#if canImport(SwiftUI) + +import SwiftUI + +extension Transition { + + /// + /// Creates a transition that performs a SwiftUI state change instead of a UIKit transition. + /// + /// Use this in `prepareTransition(for:)` when a route should mutate SwiftUI state (e.g. a + /// `@Binding` stored on the coordinator) rather than push/present a view controller. The body + /// closure runs inside `SwiftUI.withAnimation`, and the transition's `TransitionOptions.animated` + /// flag is respected — when `false`, no animation is applied. + /// + /// On iOS 17+/tvOS 17+ the completion handler fires from SwiftUI's animation-completion callback; + /// on earlier OSes it is invoked synchronously after the state change. + /// + /// - Parameters: + /// - animation: The SwiftUI animation to use when `TransitionOptions.animated` is `true`. + /// Defaults to `.default`. Pass `nil` to apply no animation even when animations are enabled. + /// - body: The state mutations to perform. + /// - Returns: A transition with no presentables that drives SwiftUI animations. + /// + public static func withAnimation( + animation: SwiftUI.Animation? = .default, + _ body: @MainActor @escaping () -> Void + ) -> Transition { + return Transition( + presentables: [], + animationInUse: nil + ) { _, options, completion in + if #available(iOS 17, tvOS 17, *) { + SwiftUI.withAnimation( + options.animated ? animation : nil + ) { + body() + } completion: { + completion?() + } + } else { + SwiftUI.withAnimation( + options.animated ? animation : nil + ) { + body() + } + completion?() + } + } + } + + /// + /// Creates a transition that performs a SwiftUI state change inside a given `Transaction`. + /// + /// This is the lower-level counterpart to ``withAnimation(animation:_:)`` — use it when you need + /// fine-grained control over the SwiftUI transaction (for example to set explicit + /// `Transaction.disablesAnimations`). The transaction's `disablesAnimations` flag is overwritten + /// to match `TransitionOptions.animated`. + /// + /// On iOS 17+/tvOS 17+ the completion handler fires from the transaction's animation-completion + /// callback; on earlier OSes it is invoked synchronously after the state change. + /// + /// - Parameters: + /// - transaction: An auto-closure producing the transaction to use. Re-evaluated each time + /// the transition is performed. + /// - body: The state mutations to perform inside the transaction. + /// - Returns: A transition with no presentables that wraps the body in `SwiftUI.withTransaction`. + /// + public static func withTransaction( + _ transaction: @autoclosure @escaping () -> Transaction, + body: @MainActor @escaping () -> Void + ) -> Transition { + return Transition( + presentables: [], + animationInUse: nil + ) { _, options, completion in + var transaction = transaction() + transaction.disablesAnimations = !options.animated + if #available(iOS 17, tvOS 17, *) { + transaction.addAnimationCompletion { + completion?() + } + } + SwiftUI.withTransaction(transaction) { + body() + } + if #unavailable(iOS 17, tvOS 17) { + completion?() + } + } + } + +} + +#endif diff --git a/Sources/XCoordinator/SwiftUI/View+Router.swift b/Sources/XCoordinator/SwiftUI/View+Router.swift new file mode 100644 index 00000000..9beb6228 --- /dev/null +++ b/Sources/XCoordinator/SwiftUI/View+Router.swift @@ -0,0 +1,77 @@ +// +// View+Router.swift +// XCoordinator +// +// Created by Paul Johannes Kraft (QB) on 12.05.25. +// Copyright © 2018 QuickBird Studios. All rights reserved. +// + +#if canImport(SwiftUI) + +import SwiftUI + +private struct RouterModifier: ViewModifier { + + // MARK: Properties + + let router: (any Router)? + + // MARK: Methods + + func body(content: Content) -> some View { + content + .transformEnvironment(\EnvironmentValues.routingContext) { context in + context[RouteType.self] = router?.router(for: RouteType.self) + } + } + +} + +extension View { + + /// + /// Wraps the view in a ``RedirectionRouter`` that maps a new child route type onto an existing parent router. + /// + /// Use this when a SwiftUI subtree should expose its own `Route` enum but ultimately delegate + /// transitions to a UIKit-backed parent coordinator. Triggering a `ChildRoute` from inside the view + /// (via `@Routing`) calls `map` to obtain a `ParentRoute` and triggers it on `parent`. + /// + /// - Parameters: + /// - routeType: The child route type. Defaults to inference from the closure signature. + /// - parent: The parent router that ultimately performs transitions. + /// - map: A closure mapping each `ChildRoute` to a `ParentRoute`. + /// - Returns: A view that exposes a ``RedirectionRouter`` for `ChildRoute` in its environment. + /// + public func redirect( + _ routeType: ChildRoute.Type = ChildRoute.self, + to parent: any Router, + map: @escaping (ChildRoute) -> ParentRoute + ) -> some View { + WrappedRouter { + let viewController = RoutingController(rootView: self) + let router = RedirectionRouter( + viewController: viewController, + parent: parent, + map: map + ) + viewController.routingContext.add(router) + return router + } + } + + /// + /// Registers (or overrides) the router for `RouteType` in this view's environment. + /// + /// Use this to inject a router into a SwiftUI subtree so that descendants can resolve it via + /// `@Routing`. Passing `nil` removes the router for `RouteType` from the environment. + /// + /// - Parameter router: The router to inject, or `nil` to remove it. + /// - Returns: A view whose environment contains the given router for `RouteType`. + /// + public func router(_ router: (any Router)?) -> some View { + modifier(RouterModifier(router: router)) + } + +} + +#endif diff --git a/Sources/XCoordinator/SwiftUI/View+Trigger.swift b/Sources/XCoordinator/SwiftUI/View+Trigger.swift new file mode 100644 index 00000000..122363cc --- /dev/null +++ b/Sources/XCoordinator/SwiftUI/View+Trigger.swift @@ -0,0 +1,150 @@ +// +// View+Trigger.swift +// XCoordinator +// +// Created by Paul Kraft on 09.05.2025. +// Copyright © 2018 QuickBird Studios. All rights reserved. +// + +#if canImport(SwiftUI) + +import SwiftUI + +private struct TriggerViewModifier: ViewModifier { + + // MARK: Properties + + let item: Item + let priority: TaskPriority + let skipFirst: Bool + let route: () -> RouteType? + let options: () -> TransitionOptions + let onCompleted: () async -> Void + + @Routing private var router + @State private var isFirstCall = true + + // MARK: Methods + + func body(content: Content) -> some View { + content.task(id: item, priority: priority) { + let wasFirst = isFirstCall + isFirstCall = false + guard !(skipFirst && wasFirst) else { + return + } + guard let route = route() else { + return + } + await router.trigger(route, with: options()) + await onCompleted() + } + } + +} + +extension View { + + /// + /// Triggers the given route once when the view first appears. + /// + /// Resolves the router for `RouteType` via `@Routing` and fires the route from within a `.task`. + /// Returning `nil` from the `route` closure suppresses the trigger. + /// + /// - Parameters: + /// - priority: The task priority used to run the trigger. Defaults to `.userInitiated`. + /// - route: An auto-closure producing the route to trigger. Re-evaluated each time the task runs. + /// - options: An auto-closure producing the transition options. Defaults to `.init(animated: true)`. + /// - onCompleted: An async closure invoked after the transition completes. + /// - Returns: A view that triggers the route on first appearance. + /// + public func triggerOnAppear( + priority: TaskPriority = .userInitiated, + route: @autoclosure @escaping () -> RouteType?, + with options: @autoclosure @escaping () -> TransitionOptions = TransitionOptions(animated: true), + onCompleted: @escaping () async -> Void = {} + ) -> some View { + self.modifier( + TriggerViewModifier( + item: true, + priority: priority, + skipFirst: false, + route: route, + options: options, + onCompleted: onCompleted + ) + ) + } + + /// + /// Triggers the given route whenever `item` changes, skipping the initial value. + /// + /// Useful for kicking off a navigation in response to a model change. The first invocation + /// (when the view appears with its initial `item`) is intentionally skipped to avoid firing + /// during the initial render. + /// + /// - Parameters: + /// - item: The value whose changes drive the trigger. + /// - priority: The task priority used to run the trigger. Defaults to `.userInitiated`. + /// - route: An auto-closure producing the route to trigger. + /// - options: An auto-closure producing the transition options. Defaults to `.init(animated: true)`. + /// - onCompleted: An async closure invoked after the transition completes. + /// - Returns: A view that triggers the route whenever `item` changes. + /// + public func triggerOnChange( + of item: Item, + priority: TaskPriority = .userInitiated, + route: @autoclosure @escaping () -> RouteType?, + with options: @autoclosure @escaping () -> TransitionOptions = TransitionOptions(animated: true), + onCompleted: @escaping () async -> Void = {} + ) -> some View { + self.modifier( + TriggerViewModifier( + item: item, + priority: priority, + skipFirst: true, + route: route, + options: options, + onCompleted: onCompleted + ) + ) + } + + /// + /// Triggers the given route when `condition` becomes `true`. + /// + /// The route is only fired when `condition` transitions to `true`; setting it back to `false` + /// does not trigger another transition. Like ``triggerOnChange(of:priority:route:with:onCompleted:)``, + /// the initial value is skipped. + /// + /// - Parameters: + /// - condition: The boolean whose `true` transitions drive the trigger. + /// - priority: The task priority used to run the trigger. Defaults to `.userInitiated`. + /// - route: An auto-closure producing the route to trigger when `condition` is `true`. + /// - options: An auto-closure producing the transition options. Defaults to `.init(animated: true)`. + /// - onCompleted: An async closure invoked after the transition completes. + /// - Returns: A view that triggers the route whenever `condition` becomes `true`. + /// + public func trigger( + when condition: Bool, + priority: TaskPriority = .userInitiated, + route: @autoclosure @escaping () -> RouteType, + with options: @autoclosure @escaping () -> TransitionOptions = TransitionOptions(animated: true), + onCompleted: @escaping () async -> Void = {} + ) -> some View { + self.modifier( + TriggerViewModifier( + item: condition, + priority: priority, + skipFirst: true, + route: { + condition ? route() : nil + }, + options: options, + onCompleted: onCompleted + ) + ) + } +} + +#endif diff --git a/Sources/XCoordinator/SwiftUI/WrappedRouter.swift b/Sources/XCoordinator/SwiftUI/WrappedRouter.swift new file mode 100644 index 00000000..9ad6aa0d --- /dev/null +++ b/Sources/XCoordinator/SwiftUI/WrappedRouter.swift @@ -0,0 +1,94 @@ +// +// WrappedRouter.swift +// XCoordinator +// +// Created by Paul Johannes Kraft (QB) on 20.05.25. +// Copyright © 2018 QuickBird Studios. All rights reserved. +// + +#if canImport(SwiftUI) + +import SwiftUI + +/// +/// A SwiftUI view that embeds a UIKit-backed coordinator or router and exposes it via the routing environment. +/// +/// Use `WrappedRouter` when you want to drive a coordinator-based flow from inside a SwiftUI hierarchy +/// — for example, hosting an entire `NavigationCoordinator` inside a SwiftUI scene. The `create` closure +/// is called once per view identity to instantiate the router; the resulting instance is retained for +/// the lifetime of the view, and is registered in the surrounding `RoutingContext` so descendant SwiftUI +/// views can resolve it via `@Routing`. +/// +/// ```swift +/// struct ContentView: View { +/// var body: some View { +/// WrappedRouter { UsersCoordinator() } +/// } +/// } +/// ``` +/// +public struct WrappedRouter: View { + + // MARK: Nested Types + + /// Holds the lazily-created router and its routing context for the lifetime of the view. + /// + /// This is a reference type so the router is created exactly once and the context can be built + /// without mutating SwiftUI `@State` during a view update. + @MainActor + private final class Holder: ObservableObject { + private var router: RouterType? + private(set) var routingContext = RoutingContext() + + func makeRouter(_ create: () -> RouterType) -> RouterType { + if let router { + return router + } + let router = create() + routingContext.add(router) + self.router = router + return router + } + } + + // MARK: Stored Properties + + @StateObject private var holder = Holder() + private let create: () -> RouterType + private let update: (UIViewController, any RepresentableContext) -> Void + + // MARK: Computed Properties + + public var body: some View { + let router = holder.makeRouter(create) + return Representable { + router + } update: { + update($0, $1) + } + .routingContext(holder.routingContext) + } + + // MARK: Initialization + + /// + /// Creates a wrapped router view. + /// + /// - Parameters: + /// - create: A closure that builds the router. Called once per view identity, on first appearance. + /// The returned router is retained for the lifetime of the view and registered in the + /// routing context propagated to descendants. + /// - update: A closure invoked on each SwiftUI update of the underlying representable. Use it + /// to forward SwiftUI state into the hosted UIKit view controller. Defaults to a no-op. + /// + public init( + create: @escaping () -> RouterType, + update: @escaping (UIViewController, any RepresentableContext) -> Void = { _, _ in } + ) { + self.create = create + self.update = update + } + +} + +#endif diff --git a/Sources/XCoordinator/TabBarAnimationDelegate.swift b/Sources/XCoordinator/Tab/TabBarAnimationDelegate.swift similarity index 97% rename from Sources/XCoordinator/TabBarAnimationDelegate.swift rename to Sources/XCoordinator/Tab/TabBarAnimationDelegate.swift index 1f10049a..5c6dd598 100755 --- a/Sources/XCoordinator/TabBarAnimationDelegate.swift +++ b/Sources/XCoordinator/Tab/TabBarAnimationDelegate.swift @@ -128,6 +128,7 @@ extension TabBarAnimationDelegate: UITabBarControllerDelegate { /// - Parameters: /// - tabBarController: The delegate owner. /// - viewControllers: The source viewControllers. + /// - changed: Whether the order of the viewControllers changed. /// open func tabBarController(_ tabBarController: UITabBarController, didEndCustomizing viewControllers: [UIViewController], changed: Bool) { @@ -143,6 +144,7 @@ extension TabBarAnimationDelegate: UITabBarControllerDelegate { /// - Parameters: /// - tabBarController: The delegate owner. /// - viewControllers: The source viewControllers. + /// - changed: Whether the order of the viewControllers changed. /// open func tabBarController(_ tabBarController: UITabBarController, willEndCustomizing viewControllers: [UIViewController], changed: Bool) { diff --git a/Sources/XCoordinator/Tab/TabBarCoordinator.swift b/Sources/XCoordinator/Tab/TabBarCoordinator.swift new file mode 100755 index 00000000..02053172 --- /dev/null +++ b/Sources/XCoordinator/Tab/TabBarCoordinator.swift @@ -0,0 +1,242 @@ +// +// TabBarCoordinator.swift +// XCoordinator +// +// Created by Paul Kraft on 29.07.18. +// Copyright © 2018 QuickBird Studios. All rights reserved. +// + +#if canImport(Combine) && canImport(SwiftUI) + +import Combine +import SwiftUI + +#endif + +import UIKit + +/// +/// Use a TabBarCoordinator to coordinate a flow where a `UITabbarController` serves as a rootViewController. +/// With a TabBarCoordinator, you get access to all tabbarController-related transitions. +/// +open class TabBarCoordinator: BaseCoordinator { + + // MARK: Stored properties + + /// Internal animation delegate installed as the tab-bar controller's `delegate` when none was set. + /// External callers should install their own delegate via the public ``delegate`` property. + private let animationDelegate = TabBarAnimationDelegate() + // swiftlint:disable:previous weak_delegate + + internal var strongReferences = [Any]() + + // MARK: Computed properties + + /// + /// Use this delegate to get informed about tabbarController-related notifications and delegate methods + /// specifying transition animations. The delegate is only referenced weakly. + /// + /// Set this delegate instead of overriding the delegate of the rootViewController + /// specified in the initializer, if possible, to allow for transition animations + /// to be executed as specified in the `prepareTransition(for:)` method. + /// + public var delegate: UITabBarControllerDelegate? { + get { + animationDelegate.delegate + } + set { + animationDelegate.delegate = newValue + } + } + + // MARK: Initialization + + /// + /// Creates a TabBarCoordinator and optionally triggers an initial route. + /// + /// - Parameters: + /// - rootViewController: The `UITabBarController` to host transitions. Defaults to a fresh instance. + /// - initialRoute: A route to trigger once the coordinator is shown. + /// + public override init(rootViewController: RootViewController = .init(), initialRoute: RouteType?) { + if rootViewController.delegate == nil { + rootViewController.delegate = animationDelegate + } + super.init(rootViewController: rootViewController, initialRoute: initialRoute) + } + + /// + /// Creates a TabBarCoordinator and optionally performs an initial transition. + /// + /// - Parameters: + /// - rootViewController: The `UITabBarController` to host transitions. + /// - initialTransition: A transition to perform once the coordinator is shown. Pass `nil` to skip. + /// + public override init(rootViewController: RootViewController, initialTransition: TabBarTransition?) { + if rootViewController.delegate == nil { + rootViewController.delegate = animationDelegate + } + super.init(rootViewController: rootViewController, initialTransition: initialTransition) + } + + /// + /// Creates a TabBarCoordinator and performs an initial transition described with the transition builder. + /// + /// - Parameters: + /// - rootViewController: The `UITabBarController` to host transitions. + /// - initialTransition: A transition-builder closure describing the transition to perform. + /// + public override init(rootViewController: RootViewController, + @TransitionBuilder initialTransition: () -> TabBarTransition) { + if rootViewController.delegate == nil { + rootViewController.delegate = animationDelegate + } + super.init(rootViewController: rootViewController, initialTransition: initialTransition()) + } + + /// + /// Creates a TabBarCoordinator with a specified set of tabs. + /// + /// - Parameters: + /// - rootViewController: The `UITabBarController` to host transitions. Defaults to a fresh instance. + /// - tabs: The presentables to use as tabs. + /// + public init(rootViewController: RootViewController = .init(), tabs: [Presentable]) { + if rootViewController.delegate == nil { + rootViewController.delegate = animationDelegate + } + super.init(rootViewController: rootViewController, initialTransition: .set(tabs)) + } + + /// + /// Creates a TabBarCoordinator with a specified set of tabs and selects a specific presentable. + /// + /// - Parameters: + /// - rootViewController: The `UITabBarController` to host transitions. Defaults to a fresh instance. + /// - tabs: The presentables to use as tabs. + /// - select: The presentable to select before displaying. Must be one of `tabs`. + /// + public init(rootViewController: RootViewController = .init(), tabs: [Presentable], select: Presentable) { + if rootViewController.delegate == nil { + rootViewController.delegate = animationDelegate + } + super.init(rootViewController: rootViewController, + initialTransition: .multiple(.set(tabs), .select(select))) + } + + /// + /// Creates a TabBarCoordinator with a specified set of tabs and selects a presentable at a given index. + /// + /// - Parameters: + /// - rootViewController: The `UITabBarController` to host transitions. Defaults to a fresh instance. + /// - tabs: The presentables to use as tabs. + /// - select: The index of the tab to select before displaying. + /// + public init(rootViewController: RootViewController = .init(), tabs: [Presentable], select: Int) { + if rootViewController.delegate == nil { + rootViewController.delegate = animationDelegate + } + super.init(rootViewController: rootViewController, + initialTransition: .multiple(.set(tabs), .select(index: select))) + } + + #if canImport(Combine) && canImport(SwiftUI) + + /// + /// Creates a tab bar coordinator whose selection is driven by a SwiftUI `Binding`. + /// + /// The `selection` binding stays in sync with the tab bar's selected item: external changes to + /// the binding update the selected tab, and user-driven tab changes write back to the binding. + /// + /// - Parameters: + /// - rootViewController: The tab bar controller. Defaults to a fresh instance. + /// - items: The data items to render as tabs. + /// - selection: A binding to the currently selected item. + /// - content: A closure that builds a view controller for each item. + /// + public init( + rootViewController: RootViewController = .init(), + items: Items, + selection: Binding, + content: (Items.Element) -> UIViewController + ) where Items.Index == Int, Items.Element: Equatable { + // Work against a 0-based array so the tab bar's 0-based selectedIndex always lines up + // with both `tabs` and the items (the source collection's indices may be offset, e.g. a slice). + let items = Array(items) + let tabs = items.map(content) + if rootViewController.delegate == nil { + rootViewController.delegate = animationDelegate + } + + if let selectedOffset = items.firstIndex(of: selection.wrappedValue) { + super.init(rootViewController: rootViewController, + initialTransition: .multiple(.set(tabs), .select(tabs[selectedOffset]))) + } else { + super.init(rootViewController: rootViewController, initialTransition: .set(tabs)) + } + + let cancellable = Publishers.Merge( + rootViewController + .publisher(for: \.selectedViewController, options: [.new]) + .compactMap { [weak self] _ in self?.rootViewController.selectedIndex }, + rootViewController + .publisher(for: \.selectedIndex, options: [.new]) + ) + .removeDuplicates() + .receive(on: DispatchQueue.main) + .sink { index in + guard items.indices.contains(index) else { return } + selection.wrappedValue = items[index] + } + strongReferences.append(cancellable) + } + + /// + /// Creates a tab bar coordinator whose selection is a `CaseIterable & Equatable` enum. + /// + /// Convenience over ``init(rootViewController:items:selection:content:)`` for enum-typed + /// selections — the `items` are derived from `Item.allCases`. + /// + /// - Parameters: + /// - rootViewController: The tab bar controller. Defaults to a fresh instance. + /// - selection: A binding to the currently selected case. + /// - content: A closure that builds a view controller for each case. + /// + public init( + rootViewController: RootViewController = .init(), + selection: Binding, + content: (Item) -> UIViewController + ) where Item.AllCases.Index == Int { + // Work against a 0-based array so the tab bar's 0-based selectedIndex always lines up + // with both `tabs` and the cases (AllCases indices may be offset). + let cases = Array(Item.allCases) + let tabs = cases.map(content) + if rootViewController.delegate == nil { + rootViewController.delegate = animationDelegate + } + + if let selectedOffset = cases.firstIndex(of: selection.wrappedValue) { + super.init(rootViewController: rootViewController, + initialTransition: .multiple(.set(tabs), .select(tabs[selectedOffset]))) + } else { + super.init(rootViewController: rootViewController, initialTransition: .set(tabs)) + } + + let cancellable = Publishers.Merge( + rootViewController + .publisher(for: \.selectedViewController, options: [.new]) + .compactMap { [weak self] _ in self?.rootViewController.selectedIndex }, + rootViewController + .publisher(for: \.selectedIndex, options: [.new]) + ) + .removeDuplicates() + .receive(on: DispatchQueue.main) + .sink { index in + guard cases.indices.contains(index) else { return } + selection.wrappedValue = cases[index] + } + strongReferences.append(cancellable) + } + #endif + +} diff --git a/Sources/XCoordinator/TabBarTransition.swift b/Sources/XCoordinator/Tab/TabBarTransition.swift similarity index 94% rename from Sources/XCoordinator/TabBarTransition.swift rename to Sources/XCoordinator/Tab/TabBarTransition.swift index deea83b0..4972f39c 100755 --- a/Sources/XCoordinator/TabBarTransition.swift +++ b/Sources/XCoordinator/Tab/TabBarTransition.swift @@ -26,7 +26,7 @@ extension Transition where RootViewController: UITabBarController { /// - animation: /// The animation to be used. If you specify `nil` here, the default animation by UIKit is used. /// - public static func set(_ presentables: [Presentable], animation: Animation? = nil) -> Transition { + public static func set(_ presentables: [any Presentable], animation: Animation? = nil) -> Transition { Transition(presentables: presentables, animationInUse: animation?.presentationAnimation ) { rootViewController, options, completion in @@ -53,7 +53,7 @@ extension Transition where RootViewController: UITabBarController { /// - animation: /// The animation to be used. If you specify `nil` here, the default animation by UIKit is used. /// - public static func select(_ presentable: Presentable, animation: Animation? = nil) -> Transition { + public static func select(_ presentable: any Presentable, animation: Animation? = nil) -> Transition { Transition(presentables: [presentable], animationInUse: animation?.presentationAnimation ) { rootViewController, options, completion in diff --git a/Sources/XCoordinator/UITabBarController+Transition.swift b/Sources/XCoordinator/Tab/UITabBarController+Transition.swift old mode 100755 new mode 100644 similarity index 82% rename from Sources/XCoordinator/UITabBarController+Transition.swift rename to Sources/XCoordinator/Tab/UITabBarController+Transition.swift index a918f5b4..810c149d --- a/Sources/XCoordinator/UITabBarController+Transition.swift +++ b/Sources/XCoordinator/Tab/UITabBarController+Transition.swift @@ -9,7 +9,7 @@ import UIKit extension UITabBarController { - + func set(_ viewControllers: [UIViewController], with options: TransitionOptions, animation: Animation?, @@ -19,7 +19,7 @@ extension UITabBarController { viewControllers.first?.transitioningDelegate = animation } assert(animation == nil || animationDelegate != nil, """ - Animations do not work, if the navigation controller's delegate is not a NavigationAnimationDelegate. + Animations do not work, if the tab bar controller's delegate is not a TabBarAnimationDelegate. This assertion might fail, if the rootViewController specified in the TabBarCoordinator's initializer already had a delegate when initializing the TabBarCoordinator. To set another delegate of a rootViewController in a TabBarCoordinator, have a look at `TabBarCoordinator.delegate`. @@ -44,7 +44,7 @@ extension UITabBarController { viewController.transitioningDelegate = animation } assert(animation == nil || animationDelegate != nil, """ - Animations do not work, if the navigation controller's delegate is not a NavigationAnimationDelegate. + Animations do not work, if the tab bar controller's delegate is not a TabBarAnimationDelegate. This assertion might fail, if the rootViewController specified in the TabBarCoordinator's initializer already had a delegate when initializing the TabBarCoordinator. To set another delegate of a rootViewController in a TabBarCoordinator, have a look at `TabBarCoordinator.delegate`. @@ -62,11 +62,19 @@ extension UITabBarController { func select(index: Int, with options: TransitionOptions, animation: Animation?, completion: PresentationHandler?) { + guard index >= 0, index < (viewControllers?.count ?? 0) else { + assertionFailure(""" + select(index:): index \(index) is out of bounds (\(viewControllers?.count ?? 0) tabs). Ignoring the transition. + """) + completion?() + return + } + if let animation = animation { viewControllers?[index].transitioningDelegate = animation } assert(animation == nil || animationDelegate != nil, """ - Animations do not work, if the navigation controller's delegate is not a NavigationAnimationDelegate. + Animations do not work, if the tab bar controller's delegate is not a TabBarAnimationDelegate. This assertion might fail, if the rootViewController specified in the TabBarCoordinator's initializer already had a delegate when initializing the TabBarCoordinator. To set another delegate of a rootViewController in a TabBarCoordinator, have a look at `TabBarCoordinator.delegate`. @@ -81,5 +89,5 @@ extension UITabBarController { CATransaction.commit() } - + } diff --git a/Sources/XCoordinator/TabBarCoordinator.swift b/Sources/XCoordinator/TabBarCoordinator.swift deleted file mode 100755 index d8ca8540..00000000 --- a/Sources/XCoordinator/TabBarCoordinator.swift +++ /dev/null @@ -1,102 +0,0 @@ -// -// TabBarCoordinator.swift -// XCoordinator -// -// Created by Paul Kraft on 29.07.18. -// Copyright © 2018 QuickBird Studios. All rights reserved. -// - -import UIKit - -/// -/// Use a TabBarCoordinator to coordinate a flow where a `UITabbarController` serves as a rootViewController. -/// With a TabBarCoordinator, you get access to all tabbarController-related transitions. -/// -open class TabBarCoordinator: BaseCoordinator { - - // MARK: Stored properties - - /// - /// The animation delegate controlling the rootViewController's transition animations. - /// This animation delegate is set to be the rootViewController's rootViewController, if you did not set one earlier. - /// - /// - Note: - /// Use the `delegate` property to set a custom delegate and use transition animations provided by XCoordinator. - /// - private let animationDelegate = TabBarAnimationDelegate() - // swiftlint:disable:previous weak_delegate - - // MARK: Computed properties - - /// - /// Use this delegate to get informed about tabbarController-related notifications and delegate methods - /// specifying transition animations. The delegate is only referenced weakly. - /// - /// Set this delegate instead of overriding the delegate of the rootViewController - /// specified in the initializer, if possible, to allow for transition animations - /// to be executed as specified in the `prepareTransition(for:)` method. - /// - public var delegate: UITabBarControllerDelegate? { - get { - animationDelegate.delegate - } - set { - animationDelegate.delegate = newValue - } - } - - // MARK: Initialization - - public override init(rootViewController: RootViewController = .init(), initialRoute: RouteType?) { - if rootViewController.delegate == nil { - rootViewController.delegate = animationDelegate - } - super.init(rootViewController: rootViewController, initialRoute: initialRoute) - } - - /// - /// Creates a TabBarCoordinator with a specified set of tabs. - /// - /// - Parameter tabs: - /// The presentables to be used as tabs. - /// - public init(rootViewController: RootViewController = .init(), tabs: [Presentable]) { - if rootViewController.delegate == nil { - rootViewController.delegate = animationDelegate - } - super.init(rootViewController: rootViewController, initialTransition: .set(tabs)) - } - - /// - /// Creates a TabBarCoordinator with a specified set of tabs and selects a specific presentable. - /// - /// - Parameters: - /// - tabs: The presentables to be used as tabs. - /// - select: - /// The presentable to be selected before displaying. Make sure, this presentable is one of the - /// specified tabs in the other parameter. - /// - public init(rootViewController: RootViewController = .init(), tabs: [Presentable], select: Presentable) { - if rootViewController.delegate == nil { - rootViewController.delegate = animationDelegate - } - super.init(rootViewController: rootViewController, - initialTransition: .multiple(.set(tabs), .select(select))) - } - - /// - /// Creates a TabBarCoordinator with a specified set of tabs and selects a presentable at a given index. - /// - /// - Parameters: - /// - tabs: The presentables to be used as tabs. - /// - select: The index of the presentable to be selected before displaying. - /// - public init(rootViewController: RootViewController = .init(), tabs: [Presentable], select: Int) { - if rootViewController.delegate == nil { - rootViewController.delegate = animationDelegate - } - super.init(rootViewController: rootViewController, - initialTransition: .multiple(.set(tabs), .select(index: select))) - } - -} diff --git a/Sources/XCoordinator/TransitionPerformer.swift b/Sources/XCoordinator/TransitionPerformer.swift deleted file mode 100755 index 262bbbf0..00000000 --- a/Sources/XCoordinator/TransitionPerformer.swift +++ /dev/null @@ -1,37 +0,0 @@ -// -// TransitionPerformer.swift -// XCoordinator -// -// Created by Paul Kraft on 13.09.18. -// Copyright © 2018 QuickBird Studios. All rights reserved. -// - -/// -/// The TransitionPerformer protocol is used to abstract the route-type specific characteristics of a Coordinator. -/// It keeps type information about its transition performing capabilities. -/// -public protocol TransitionPerformer: Presentable { - - /// The type of transitions that can be executed on the rootViewController. - associatedtype TransitionType: TransitionProtocol - - /// The rootViewController on which transitions are performed. - var rootViewController: TransitionType.RootViewController { get } - - /// - /// Perform a transition. - /// - /// - Warning: - /// Do not use this method directly, but instead try to use the `trigger` - /// method of your coordinator instead wherever possible. - /// - /// - Parameters: - /// - transition: The transition to be performed. - /// - options: The options on how to perform the transition, including the option to enable/disable animations. - /// - completion: The completion handler called once a transition has finished. - /// - func performTransition(_ transition: TransitionType, - with options: TransitionOptions, - completion: PresentationHandler?) - -} diff --git a/Sources/XCoordinator/TransitionProtocol.swift b/Sources/XCoordinator/TransitionProtocol.swift deleted file mode 100755 index ce58d722..00000000 --- a/Sources/XCoordinator/TransitionProtocol.swift +++ /dev/null @@ -1,55 +0,0 @@ -// -// TransitionProtocol.swift -// XCoordinator -// -// Created by Paul Kraft on 13.09.18. -// Copyright © 2018 QuickBird Studios. All rights reserved. -// - -import UIKit - -/// -/// `TransitionProtocol` is used to abstract any concrete transition implementation. -/// -/// `Transition` is provided as an easily-extensible default transition type implementation. -/// -public protocol TransitionProtocol: TransitionContext { - - /// The type of the rootViewController that can execute the transition. - associatedtype RootViewController: UIViewController - - /// - /// Performs a transition on the given viewController. - /// - /// - Warning: - /// Do not call this method directly. Instead use your coordinator's `performTransition` method or trigger - /// a specified route (latter option is encouraged). - /// - func perform(on rootViewController: RootViewController, - with options: TransitionOptions, - completion: PresentationHandler?) - - // MARK: Always accessible transitions - - /// - /// Creates a compound transition by chaining multiple transitions together. - /// - /// - Parameter transitions: - /// The transitions to be chained to form a combined transition. - /// - static func multiple(_ transitions: [Self]) -> Self -} - -extension TransitionProtocol { - - /// - /// Creates a compound transition by chaining multiple transitions together. - /// - /// - Parameter transitions: - /// The transitions to be chained to form a combined transition. - /// - public static func multiple(_ transitions: Self...) -> Self { - multiple(transitions) - } - -} diff --git a/Sources/XCoordinator/Transition.swift b/Sources/XCoordinator/Transitions/Transition.swift similarity index 93% rename from Sources/XCoordinator/Transition.swift rename to Sources/XCoordinator/Transitions/Transition.swift index ec85b90f..606e1811 100755 --- a/Sources/XCoordinator/Transition.swift +++ b/Sources/XCoordinator/Transitions/Transition.swift @@ -9,7 +9,7 @@ import UIKit /// -/// This struct represents the common implementation of the `TransitionProtocol`. +/// This struct is the single transition type used by every coordinator. /// It is used in every of the provided `BaseCoordinator` subclasses and provides all transitions implemented in XCoordinator. /// /// `Transitions` are defined by a `Transition.Perform` closure. @@ -23,7 +23,7 @@ import UIKit /// Make sure to specify the `RootViewController` type of the `TransitionType` of your coordinator as precise as possible /// to get all already available transitions. /// -public struct Transition: TransitionProtocol { +public struct Transition: TransitionContext { // MARK: Typealias @@ -45,7 +45,7 @@ public struct Transition: TransitionProtoc // MARK: Stored properties - private var _presentables: [Presentable] + private var _presentables: [any Presentable] private var _animation: TransitionAnimation? private var _perform: PerformClosure @@ -55,7 +55,7 @@ public struct Transition: TransitionProtoc /// The presentables this transition is putting into the view hierarchy. This is especially useful for /// deep-linking. /// - public var presentables: [Presentable] { + public var presentables: [any Presentable] { _presentables } @@ -91,7 +91,7 @@ public struct Transition: TransitionProtoc /// To create custom transitions, make sure to call the completion handler after all animations are done. /// If applicable, make sure to use the TransitionOptions to, e.g., decide whether a transition should be animated or not. /// - public init(presentables: [Presentable], animationInUse: TransitionAnimation?, perform: @escaping PerformClosure) { + public init(presentables: [any Presentable], animationInUse: TransitionAnimation?, perform: @escaping PerformClosure) { self._presentables = presentables self._animation = animationInUse self._perform = perform diff --git a/Sources/XCoordinator/Transitions/TransitionBuilder.swift b/Sources/XCoordinator/Transitions/TransitionBuilder.swift new file mode 100644 index 00000000..9f12938d --- /dev/null +++ b/Sources/XCoordinator/Transitions/TransitionBuilder.swift @@ -0,0 +1,73 @@ +// +// TransitionBuilder.swift +// XCoordinator +// +// Created by Paul Kraft on 08.05.23. +// Copyright © 2018 QuickBird Studios. All rights reserved. +// + +import UIKit + +/// +/// A result builder that assembles a single ``Transition`` from one or more `Transition` values. +/// +/// Use it to describe a coordinator's transitions inline — e.g. in `prepareTransition(for:)` or a +/// `BasicCoordinator`'s `prepare` closure — by listing the `Transition.…` factories that apply to the +/// coordinator's root view controller: +/// +/// ```swift +/// override func prepareTransition(for route: AppRoute) -> NavigationTransition { +/// switch route { +/// case .home: Transition.push(HomeViewController()) +/// case .detail(let id): Transition.push(DetailViewController(id: id)) +/// case .ignored: Transition.none() +/// } +/// } +/// ``` +/// +/// Multiple statements are chained with ``Transition/multiple(_:)-(Collection)`` and +/// performed strictly in order. An empty builder block is a compile-time error — use ``Transition/none()`` +/// to express an intentional no-op. +/// +@MainActor +@resultBuilder +public enum TransitionBuilder { + + public static func buildExpression(_ expression: Transition) -> Transition { + expression + } + + public static func buildExpression(_ expression: Never) -> Transition {} + + public static func buildEither(first component: Transition) -> Transition { + component + } + + public static func buildEither(second component: Transition) -> Transition { + component + } + + public static func buildOptional(_ component: Transition?) -> Transition { + component ?? .none() + } + + public static func buildLimitedAvailability(_ component: Transition) -> Transition { + component + } + + public static func buildBlock( + _ first: Transition, + _ rest: Transition... + ) -> Transition { + rest.isEmpty ? first : .multiple([first] + rest) + } + + public static func buildArray(_ components: [Transition]) -> Transition { + .multiple(components) + } + + public static func buildFinalResult(_ component: Transition) -> Transition { + component + } + +} diff --git a/Sources/XCoordinator/Transitions/TransitionContext.swift b/Sources/XCoordinator/Transitions/TransitionContext.swift new file mode 100644 index 00000000..8fd32a40 --- /dev/null +++ b/Sources/XCoordinator/Transitions/TransitionContext.swift @@ -0,0 +1,22 @@ +// +// TransitionContext.swift +// XCoordinator +// +// Created by Paul Kraft on 13.09.18. +// Copyright © 2018 QuickBird Studios. All rights reserved. +// + +/// +/// A non-generic view of a performed transition, used where the concrete root-view-controller type +/// is not known — e.g. on `Router`, whose only knowledge is its `RouteType`. +/// +/// The context-based `trigger` variants (`contextTrigger`, the async overload, and the Combine/RxSwift +/// wrappers) hand back the performed transition as `any TransitionContext`. Deep linking +/// (`General/DeepLinking.swift`) uses ``presentables`` to walk the resulting coordinator tree. +/// +@MainActor +public protocol TransitionContext { + + /// The presentables introduced into the view hierarchy by the transition. + var presentables: [any Presentable] { get } +} diff --git a/Sources/XCoordinator/TransitionOptions.swift b/Sources/XCoordinator/Transitions/TransitionOptions.swift similarity index 92% rename from Sources/XCoordinator/TransitionOptions.swift rename to Sources/XCoordinator/Transitions/TransitionOptions.swift index b6d77a32..96b45efc 100755 --- a/Sources/XCoordinator/TransitionOptions.swift +++ b/Sources/XCoordinator/Transitions/TransitionOptions.swift @@ -39,7 +39,8 @@ public struct TransitionOptions { // MARK: Static computed properties - static var `default`: TransitionOptions { + /// The default transition options (animated). + public static var `default`: TransitionOptions { TransitionOptions(animated: true) } diff --git a/Sources/XCoordinator/UIPageViewController+Transition.swift b/Sources/XCoordinator/UIPageViewController+Transition.swift deleted file mode 100755 index 11b27969..00000000 --- a/Sources/XCoordinator/UIPageViewController+Transition.swift +++ /dev/null @@ -1,23 +0,0 @@ -// -// UIPageViewController+Transition.swift -// XCoordinator -// -// Created by Paul Kraft on 30.07.18. -// Copyright © 2018 QuickBird Studios. All rights reserved. -// - -import UIKit - -extension UIPageViewController { - func set(_ viewControllers: [UIViewController], - direction: UIPageViewController.NavigationDirection, - with options: TransitionOptions, - completion: PresentationHandler?) { - setViewControllers( - viewControllers, - direction: direction, - animated: options.animated, - completion: { _ in completion?() } - ) - } -} diff --git a/Sources/XCoordinator/UIView+Store.swift b/Sources/XCoordinator/UIView+Store.swift deleted file mode 100755 index 58915aad..00000000 --- a/Sources/XCoordinator/UIView+Store.swift +++ /dev/null @@ -1,40 +0,0 @@ -// -// UIView+Store.swift -// XCoordinator -// -// Created by Stefan Kofler on 19.07.18. -// Copyright © 2018 QuickBird Studios. All rights reserved. -// - -import UIKit - -private var associatedObjectHandle: UInt8 = 0 - -extension UIView { - - var strongReferences: [Any] { - get { - objc_getAssociatedObject(self, &associatedObjectHandle) as? [Any] ?? [] - } - set { - objc_setAssociatedObject(self, &associatedObjectHandle, newValue, .OBJC_ASSOCIATION_RETAIN_NONATOMIC) - } - } -} - -extension UIView { - - @discardableResult - func removePreviewingContext(for _: TransitionType.Type) - -> UIViewControllerPreviewing? { - guard let existingContextIndex = strongReferences - .firstIndex(where: { $0 is CoordinatorPreviewingDelegateObject }), - let contextDelegate = strongReferences - .remove(at: existingContextIndex) as? CoordinatorPreviewingDelegateObject, - let context = contextDelegate.context else { - return nil - } - return context - } - -} diff --git a/Sources/XCoordinator/UnownedErased+Router.swift b/Sources/XCoordinator/UnownedErased+Router.swift deleted file mode 100644 index f819d5e6..00000000 --- a/Sources/XCoordinator/UnownedErased+Router.swift +++ /dev/null @@ -1,62 +0,0 @@ -// -// UnownedErased+Router.swift -// XCoordinator -// -// Created by Paul Kraft on 02.09.19. -// Copyright © 2018 QuickBird Studios. All rights reserved. -// - -import UIKit - -/// -/// Please use `StrongRouter`, `WeakRouter` or `UnownedRouter` instead. -/// -/// - Note: -/// Use a `StrongRouter`, if you need to hold a router even -/// when it is not in the view hierarchy. -/// Use a `WeakRouter` or `UnownedRouter` when you are accessing -/// any router from the view hierarchy. -/// -@available(iOS, deprecated) -public typealias AnyRouter = UnownedRouter - -/// -/// An `UnownedRouter` is an unowned version of a router object to be used in view controllers or view models. -/// -/// - Note: -/// Do not create an `UnownedRouter` from a `StrongRouter` since `StrongRouter` is only another wrapper -/// and does not represent the might instantly -/// -public typealias UnownedRouter = UnownedErased> - -extension UnownedErased: Presentable where Value: Presentable { - - public var viewController: UIViewController! { - wrappedValue.viewController - } - - public func childTransitionCompleted() { - wrappedValue.childTransitionCompleted() - } - - public func registerParent(_ presentable: Presentable & AnyObject) { - wrappedValue.registerParent(presentable) - } - - public func presented(from presentable: Presentable?) { - wrappedValue.presented(from: presentable) - } - - public func setRoot(for window: UIWindow) { - wrappedValue.setRoot(for: window) - } - -} - -extension UnownedErased: Router where Value: Router { - - public func contextTrigger(_ route: Value.RouteType, with options: TransitionOptions, completion: ContextPresentationHandler?) { - wrappedValue.contextTrigger(route, with: options, completion: completion) - } - -} diff --git a/Sources/XCoordinator/UnownedErased.swift b/Sources/XCoordinator/UnownedErased.swift deleted file mode 100644 index 1eb5216a..00000000 --- a/Sources/XCoordinator/UnownedErased.swift +++ /dev/null @@ -1,72 +0,0 @@ -// -// File.swift -// -// -// Created by Paul Kraft on 21.06.19. -// - -import Foundation - -#if swift(>=5.1) - -/// -/// `UnownedErased` is a property wrapper to hold objects with an unowned reference when using type-erasure. -/// -/// Create this wrapper using an initial value and a closure to create the type-erased object. -/// Make sure to not create an `UnownedErased` wrapper for already type-erased objects, -/// since their reference is most likely instantly lost. -/// -@propertyWrapper -public struct UnownedErased { - private var _value: () -> Value - - /// The type-erased or otherwise mapped version of the value being held unowned. - public var wrappedValue: Value { - _value() - } -} - -#else - -/// -/// `UnownedErased` is a property wrapper to hold objects with an unowned reference when using type-erasure. -/// -/// Create this wrapper using an initial value and a closure to create the type-erased object. -/// Make sure to not create an `UnownedErased` wrapper for already type-erased objects, -/// since their reference is most likely instantly lost. -/// -public struct UnownedErased { - private var _value: () -> Value - - /// The type-erased or otherwise mapped version of the value being held unowned. - public var wrappedValue: Value { - _value() - } -} - -#endif - -extension UnownedErased { - - /// - /// Create an `UnownedErased` wrapper using an initial value and a closure to create the type-erased object. - /// Make sure to not create an `UnownedErased` wrapper for already type-erased objects, - /// since their reference is most likely instantly lost. - /// - public init(_ value: Erasable, erase: @escaping (Erasable) -> Value) { - self._value = UnownedErased.createValueClosure(for: value, erase: erase) - } - - /// - /// Set a new value by providing a non-type-erased value and a closure to create the type-erased object. - /// - public mutating func set(_ value: Erasable, erase: @escaping (Erasable) -> Value) { - self._value = UnownedErased.createValueClosure(for: value, erase: erase) - } - - private static func createValueClosure( - for value: Erasable, - erase: @escaping (Erasable) -> Value) -> () -> Value { - { [unowned value] in erase(value) } - } -} diff --git a/Sources/XCoordinator/View/Coordinator+ContextMenu.swift b/Sources/XCoordinator/View/Coordinator+ContextMenu.swift new file mode 100644 index 00000000..b1f4ec7a --- /dev/null +++ b/Sources/XCoordinator/View/Coordinator+ContextMenu.swift @@ -0,0 +1,46 @@ +// +// Coordinator+ContextMenu.swift +// XCoordinator +// +// Created by Paul Kraft on 13.02.20. +// Copyright © 2020 QuickBird Studios. All rights reserved. +// + +#if os(iOS) + +import UIKit + +extension Coordinator where Self: AnyObject { + + /// + /// Creates a `UIContextMenuInteractionDelegate` that generates a preview from a given route and + /// performs that route when the preview is committed. + /// + /// The preview shown is the view controller produced by the route's transition. Committing the preview + /// triggers the route on this coordinator via ``performTransition(_:with:completion:)``, so any presented + /// presentables are correctly retained as children. + /// + /// - Parameters: + /// - route: The route to be triggered when the preview is committed. + /// - identifier: An optional identifier for the context menu configuration. + /// - menu: The menu to be shown alongside the preview. + /// - completion: A closure called once the route's transition completes. + /// + public func contextMenuInteractionDelegate( + for route: RouteType, + identifier: NSCopying? = nil, + menu: UIMenu? = nil, + completion: PresentationHandler? = nil + ) -> UIContextMenuInteractionDelegate { + CoordinatorContextMenuInteractionDelegate( + coordinator: self, + route: route, + identifier: identifier, + menu: menu, + completion: completion + ) + } + +} + +#endif diff --git a/Sources/XCoordinator/View/CoordinatorContextMenuInteractionDelegate.swift b/Sources/XCoordinator/View/CoordinatorContextMenuInteractionDelegate.swift new file mode 100644 index 00000000..b9017535 --- /dev/null +++ b/Sources/XCoordinator/View/CoordinatorContextMenuInteractionDelegate.swift @@ -0,0 +1,95 @@ +// +// CoordinatorContextMenuInteractionDelegate.swift +// XCoordinator +// +// Created by Paul Kraft on 13.02.20. +// Copyright © 2020 QuickBird Studios. All rights reserved. +// + +#if os(iOS) + +import UIKit + +/// +/// A `UIContextMenuInteractionDelegate` that previews and triggers a coordinator route. +/// +/// The preview is the view controller produced by the route's transition; committing the preview performs +/// that route on the coordinator. +/// +/// - Important: +/// The route is performed via the coordinator's ``Coordinator/performTransition(_:with:completion:)``, +/// **not** by running the transition directly. This is what keeps the presented presentables retained as +/// children of the coordinator — performing the transition directly would bypass child management and the +/// presented coordinator would be deallocated immediately (see `CoordinatorChildLifecycleTests`). +/// +internal final class CoordinatorContextMenuInteractionDelegate: NSObject, + UIContextMenuInteractionDelegate { + + // MARK: Stored properties + + private let identifier: NSCopying? + private let route: C.RouteType + private let menu: UIMenu? + private weak var coordinator: C? + private let completion: PresentationHandler? + + // MARK: Initialization + + internal init( + coordinator: C, + route: C.RouteType, + identifier: NSCopying?, + menu: UIMenu?, + completion: PresentationHandler? + ) { + self.coordinator = coordinator + self.route = route + self.identifier = identifier + self.menu = menu + self.completion = completion + } + + // MARK: Methods + + internal func contextMenuInteraction( + _ interaction: UIContextMenuInteraction, + configurationForMenuAtLocation location: CGPoint + ) -> UIContextMenuConfiguration? { + UIContextMenuConfiguration( + identifier: identifier, + previewProvider: { [weak self] in + guard let self else { return nil } + return self.coordinator?.prepareTransition(for: self.route).presentables.last?.viewController + }, + actionProvider: { [weak self] _ in + self?.menu + } + ) + } + + internal func contextMenuInteraction( + _ interaction: UIContextMenuInteraction, + willPerformPreviewActionForMenuWith configuration: UIContextMenuConfiguration, + animator: UIContextMenuInteractionCommitAnimating + ) { + animator.addCompletion { [weak self] in + self?.performRoute() + } + } + + /// Performs the configured route on the coordinator, keeping child management intact. + /// + /// Factored out of the delegate callback so it can be exercised directly in tests without a live + /// `UIContextMenuInteractionCommitAnimating`. + internal func performRoute() { + guard let coordinator else { return } + coordinator.performTransition( + coordinator.prepareTransition(for: route), + with: .default, + completion: completion + ) + } + +} + +#endif diff --git a/Sources/XCoordinator/Transition+Init.swift b/Sources/XCoordinator/View/Transition+Init.swift similarity index 75% rename from Sources/XCoordinator/Transition+Init.swift rename to Sources/XCoordinator/View/Transition+Init.swift index d73ae128..73234e9f 100755 --- a/Sources/XCoordinator/Transition+Init.swift +++ b/Sources/XCoordinator/View/Transition+Init.swift @@ -20,7 +20,7 @@ extension Transition { /// - Parameter presentable: /// The presentable to be shown as a primary view controller. /// - public static func show(_ presentable: Presentable) -> Transition { + public static func show(_ presentable: any Presentable) -> Transition { Transition(presentables: [presentable], animationInUse: nil) { rootViewController, options, completion in rootViewController.show( presentable.viewController, @@ -42,7 +42,7 @@ extension Transition { /// - Parameter presentable: /// The presentable to be shown as a detail view controller. /// - public static func showDetail(_ presentable: Presentable) -> Transition { + public static func showDetail(_ presentable: any Presentable) -> Transition { Transition(presentables: [presentable], animationInUse: nil) { rootViewController, options, completion in rootViewController.showDetail( presentable.viewController, @@ -67,7 +67,7 @@ extension Transition { /// the current transitioningDelegate and `Animation.default` to reset the transitioningDelegate to use /// the default UIKit animations. /// - public static func presentOnRoot(_ presentable: Presentable, animation: Animation? = nil) -> Transition { + public static func presentOnRoot(_ presentable: any Presentable, animation: Animation? = nil) -> Transition { Transition(presentables: [presentable], animationInUse: animation?.presentationAnimation ) { rootViewController, options, completion in @@ -93,7 +93,7 @@ extension Transition { /// the current transitioningDelegate and `Animation.default` to reset the transitioningDelegate to use /// the default UIKit animations. /// - public static func present(_ presentable: Presentable, animation: Animation? = nil) -> Transition { + public static func present(_ presentable: any Presentable, animation: Animation? = nil) -> Transition { Transition(presentables: [presentable], animationInUse: animation?.presentationAnimation ) { rootViewController, options, completion in @@ -115,7 +115,7 @@ extension Transition { /// - presentable: The presentable to be embedded. /// - container: The container to embed the presentable in. /// - public static func embed(_ presentable: Presentable, in container: Container) -> Transition { + public static func embed(_ presentable: any Presentable, in container: any Container) -> Transition { Transition(presentables: [presentable], animationInUse: nil) { rootViewController, options, completion in rootViewController.embed(presentable.viewController, in: container, @@ -183,7 +183,20 @@ extension Transition { /// - Parameter transitions: /// The transitions to be chained to form the new transition. /// - public static func multiple(_ transitions: C) -> Transition where C.Element == Transition { + public static func multiple(_ transitions: Transition...) -> Transition { + multiple(transitions) + } + + /// + /// With this transition you can chain multiple transitions of the same type together. + /// + /// Each transition is performed strictly after the previous one has fully completed, since a + /// transition may fail if a prior one is still in progress. + /// + /// - Parameter transitions: + /// The transitions to be chained to form the new transition. + /// + public static func multiple(_ transitions: some Collection) -> Transition { Transition(presentables: transitions.flatMap { $0.presentables }, animationInUse: transitions.compactMap { $0.animation }.last ) { rootViewController, options, completion in @@ -227,7 +240,7 @@ extension Transition { /// - route: The route to be triggered on the coordinator. /// - router: The router to trigger the route on. /// - public static func trigger(_ route: R.RouteType, on router: R) -> Transition { + public static func trigger(_ route: RouteType, on router: any Router) -> Transition { Transition(presentables: [], animationInUse: nil) { _, options, completion in router.trigger(route, with: options, completion: completion) } @@ -242,35 +255,57 @@ extension Transition { /// - transition: The transition to be performed. /// - viewController: The viewController to perform the transition on. /// - public static func perform(_ transition: TransitionType, - on viewController: TransitionType.RootViewController) -> Transition { + public static func perform(_ transition: Transition, + on viewController: OtherRoot) -> Transition { Transition(presentables: transition.presentables, animationInUse: transition.animation) { _, options, completion in transition.perform(on: viewController, with: options, completion: completion) } } + /// + /// Performs a transition — described with the transition builder — on a different viewController + /// than the coordinator's rootViewController. + /// + /// - Parameters: + /// - viewController: The viewController to perform the transition on. + /// - transition: A transition-builder closure describing the transition to perform. + /// + public static func perform( + on viewController: OtherRoot, + @TransitionBuilder _ transition: () -> Transition + ) -> Transition { + perform(transition(), on: viewController) + } + } -extension Coordinator where Self: AnyObject { +extension Transition { /// - /// Use this transition to register 3D Touch Peek and Pop functionality. + /// Creates a transition that runs an async closure on the main actor and completes once the closure returns. + /// + /// Use this to bridge async work into the coordinator transition pipeline — for example, awaiting a + /// loading operation before triggering a follow-up transition. /// /// - Parameters: - /// - source: The view to register peek and pop on. - /// - route: The route to be triggered for peek and pop. - /// - @available(iOS, introduced: 9.0, deprecated: 13.0, message: "Use `UIContextMenuInteraction` instead.") - public func registerPeek(for source: Container, - route: RouteType - ) -> Transition where Self.TransitionType == Transition { - let transitionGenerator = { [weak self] () -> TransitionType in - self?.prepareTransition(for: route) ?? .none() - } - return Transition(presentables: [], animationInUse: nil) { rootViewController, _, completion in - rootViewController.registerPeek(from: source.view, - transitionGenerator: transitionGenerator, - completion: completion) + /// - presentables: The presentables this transition introduces into the view hierarchy, if any. + /// These are used by deep-linking and child tracking. Defaults to empty. + /// - animationInUse: The transition animation to expose, if any. Defaults to `nil`. + /// - priority: The task priority used to run `perform`. Defaults to the inherited priority. + /// - perform: The async closure to run. + /// - Returns: A transition that completes once `perform` returns. + /// + public static func perform( + presentables: [any Presentable] = [], + animationInUse: TransitionAnimation? = nil, + priority: TaskPriority? = nil, + _ perform: @MainActor @escaping () async -> Void + ) -> Transition { + Transition(presentables: presentables, animationInUse: animationInUse) { _, _, completion in + Task(priority: priority) { @MainActor in + await perform() + completion?() + } } } diff --git a/Sources/XCoordinator/View/UIViewController+Extras.swift b/Sources/XCoordinator/View/UIViewController+Extras.swift new file mode 100644 index 00000000..0bd599c0 --- /dev/null +++ b/Sources/XCoordinator/View/UIViewController+Extras.swift @@ -0,0 +1,17 @@ +// +// UIViewController+Extras.swift +// XCoordinator +// +// Created by Paul Kraft on 08.05.23. +// Copyright © 2018 QuickBird Studios. All rights reserved. +// + +import UIKit + +extension UIViewController { + + internal var topPresentedViewController: UIViewController { + presentedViewController?.topPresentedViewController ?? self + } + +} diff --git a/Sources/XCoordinator/UIViewController+Transition.swift b/Sources/XCoordinator/View/UIViewController+Transition.swift similarity index 76% rename from Sources/XCoordinator/UIViewController+Transition.swift rename to Sources/XCoordinator/View/UIViewController+Transition.swift index 2eb20d6b..6ee8fb25 100755 --- a/Sources/XCoordinator/UIViewController+Transition.swift +++ b/Sources/XCoordinator/View/UIViewController+Transition.swift @@ -10,10 +10,6 @@ import UIKit extension UIViewController { - private var topPresentedViewController: UIViewController { - presentedViewController?.topPresentedViewController ?? self - } - func show(_ viewController: UIViewController, with options: TransitionOptions, completion: PresentationHandler?) { @@ -96,25 +92,3 @@ extension UIViewController { completion?() } } - -extension Presentable where Self: UIViewController { - - @available(iOS, introduced: 9.0, deprecated: 13.0, message: "Use `UIContextMenuInteraction` instead.") - func registerPeek( - from sourceView: UIView, - transitionGenerator: @escaping () -> TransitionType, - completion: PresentationHandler?) where TransitionType.RootViewController == Self { - let delegate = CoordinatorPreviewingDelegateObject( - transition: transitionGenerator, - rootViewController: self, - completion: completion - ) - - if let context = sourceView.removePreviewingContext(for: TransitionType.self) { - unregisterForPreviewing(withContext: context) - } - - sourceView.strongReferences.append(delegate) - delegate.context = registerForPreviewing(with: delegate, sourceView: sourceView) - } -} diff --git a/Sources/XCoordinator/View/ViewCoordinator.swift b/Sources/XCoordinator/View/ViewCoordinator.swift new file mode 100755 index 00000000..97bb9519 --- /dev/null +++ b/Sources/XCoordinator/View/ViewCoordinator.swift @@ -0,0 +1,123 @@ +// +// ViewCoordinator.swift +// XCoordinator +// +// Created by Paul Kraft on 29.07.18. +// Copyright © 2018 QuickBird Studios. All rights reserved. +// + +#if canImport(SwiftUI) + +import SwiftUI + +#endif + +import UIKit + +/// +/// ViewTransition offers transitions common to any `UIViewController` rootViewController. +/// +public typealias ViewTransition = Transition + +/// +/// ViewCoordinator is a base class for custom coordinators with a `UIViewController` rootViewController. +/// +open class ViewCoordinator: BaseCoordinator { + + // MARK: Initialization + + /// + /// Creates a view coordinator with the given root view controller and an optional initial transition. + /// + /// - Parameters: + /// - rootViewController: The view controller that hosts the coordinator's transitions. + /// - initialTransition: A transition to perform once the coordinator is shown. Pass `nil` to skip. + public override init(rootViewController: RootViewController, initialTransition: ViewTransition?) { + super.init(rootViewController: rootViewController, + initialTransition: initialTransition) + } + + /// + /// Creates a view coordinator and performs an initial transition described with the transition builder. + /// + /// - Parameters: + /// - rootViewController: The view controller that hosts the coordinator's transitions. + /// - initialTransition: A transition-builder closure describing the transition to perform. + public override init(rootViewController: RootViewController, + @TransitionBuilder initialTransition: () -> ViewTransition) { + super.init(rootViewController: rootViewController, + initialTransition: initialTransition()) + } + + /// + /// Creates a view coordinator with the given root view controller and an optional initial route. + /// + /// - Parameters: + /// - rootViewController: The view controller that hosts the coordinator's transitions. + /// - initialRoute: A route triggered once the coordinator is shown. Defaults to `nil`. + public override init(rootViewController: RootViewController, initialRoute: RouteType? = nil) { + super.init(rootViewController: rootViewController, initialRoute: initialRoute) + } + + #if canImport(SwiftUI) + + /// + /// Creates a view coordinator whose root is a SwiftUI view, optionally triggering an initial route. + /// + /// The view is hosted inside a ``RoutingController`` so it participates in the routing context. + /// + /// - Parameters: + /// - initialRoute: A route triggered once the coordinator is shown. + /// - body: A view-builder producing the SwiftUI content. + public init( + initialRoute: RouteType? = nil, + @ViewBuilder body: () -> Content + ) { + let controller = RoutingController(rootView: body()) + super.init( + rootViewController: controller, + initialRoute: initialRoute + ) + controller.routingContext.add(self) + } + + /// + /// Creates a view coordinator whose root is a SwiftUI view, optionally performing an initial transition. + /// + /// - Parameters: + /// - initialTransition: A transition to perform once the coordinator is shown. + /// - body: A view-builder producing the SwiftUI content. + public init( + initialTransition: ViewTransition?, + @ViewBuilder body: () -> Content + ) { + let controller = RoutingController(rootView: body()) + super.init( + rootViewController: controller, + initialTransition: initialTransition + ) + controller.routingContext.add(self) + } + + /// + /// Creates a view coordinator whose root is a SwiftUI view, performing an initial transition + /// described with the transition builder. + /// + /// - Parameters: + /// - initialTransition: A transition-builder closure describing the transition to perform. + /// - body: A view-builder producing the SwiftUI content. + public init( + @TransitionBuilder initialTransition: () -> ViewTransition, + @ViewBuilder body: () -> Content + ) { + let controller = RoutingController(rootView: body()) + super.init( + rootViewController: controller, + initialTransition: initialTransition() + ) + controller.routingContext.add(self) + } + + #endif + +} diff --git a/Sources/XCoordinator/ViewCoordinator.swift b/Sources/XCoordinator/ViewCoordinator.swift deleted file mode 100755 index 6c5a4769..00000000 --- a/Sources/XCoordinator/ViewCoordinator.swift +++ /dev/null @@ -1,28 +0,0 @@ -// -// ViewCoordinator.swift -// XCoordinator -// -// Created by Paul Kraft on 29.07.18. -// Copyright © 2018 QuickBird Studios. All rights reserved. -// - -import UIKit - -/// -/// ViewTransition offers transitions common to any `UIViewController` rootViewController. -/// -public typealias ViewTransition = Transition - -/// -/// ViewCoordinator is a base class for custom coordinators with a `UIViewController` rootViewController. -/// -open class ViewCoordinator: BaseCoordinator { - - // MARK: Initialization - - public override init(rootViewController: RootViewController, initialRoute: RouteType? = nil) { - super.init(rootViewController: rootViewController, - initialRoute: initialRoute) - } - -} diff --git a/Sources/XCoordinator/WeakErased+Router.swift b/Sources/XCoordinator/WeakErased+Router.swift deleted file mode 100644 index c221f506..00000000 --- a/Sources/XCoordinator/WeakErased+Router.swift +++ /dev/null @@ -1,52 +0,0 @@ -// -// WeakErased+Router.swift -// XCoordinator -// -// Created by Paul Kraft on 02.09.19. -// Copyright © 2018 QuickBird Studios. All rights reserved. -// - -import UIKit - -/// -/// A `WeakRouter` is a weak version of a router object to be used in view controllers or view models. -/// -/// - Note: -/// Do not create a `WeakRouter` from a `StrongRouter` since `StrongRouter` is only another wrapper -/// and does not represent the might instantly. -/// Also keep in mind that once the original router object has been deallocated, -/// calling `trigger` on this wrapper will have no effect. -/// -public typealias WeakRouter = WeakErased> - -extension WeakErased: Presentable where Value: Presentable { - - public var viewController: UIViewController! { - wrappedValue?.viewController - } - - public func childTransitionCompleted() { - wrappedValue?.childTransitionCompleted() - } - - public func registerParent(_ presentable: Presentable & AnyObject) { - wrappedValue?.registerParent(presentable) - } - - public func presented(from presentable: Presentable?) { - wrappedValue?.presented(from: presentable) - } - - public func setRoot(for window: UIWindow) { - wrappedValue?.setRoot(for: window) - } - -} - -extension WeakErased: Router where Value: Router { - - public func contextTrigger(_ route: Value.RouteType, with options: TransitionOptions, completion: ContextPresentationHandler?) { - wrappedValue?.contextTrigger(route, with: options, completion: completion) - } - -} diff --git a/Sources/XCoordinator/WeakErased.swift b/Sources/XCoordinator/WeakErased.swift deleted file mode 100755 index 51daf8b8..00000000 --- a/Sources/XCoordinator/WeakErased.swift +++ /dev/null @@ -1,74 +0,0 @@ -// -// WeakErased.swift -// XCoordinator -// -// Created by Paul Kraft on 30.10.18. -// Copyright © 2018 QuickBird Studios. All rights reserved. -// - -import Foundation - -#if swift(>=5.1) - -/// -/// `WeakErased` is a property wrapper to hold objects with a weak reference when using type-erasure. -/// -/// Create this wrapper using an initial value and a closure to create the type-erased object. -/// Make sure to not create a `WeakErased` wrapper for already type-erased objects, -/// since their reference is most likely instantly lost. -/// -@propertyWrapper -public struct WeakErased { - private var _value: () -> Value? - - /// The type-erased or otherwise mapped version of the value being held weakly. - public var wrappedValue: Value? { - _value() - } -} - -#else - -/// -/// `WeakErased` is a property wrapper to hold objects with a weak reference when using type-erasure. -/// -/// Create this wrapper using an initial value and a closure to create the type-erased object. -/// Make sure to not create a `WeakErased` wrapper for already type-erased objects, -/// since their reference is most likely instantly lost. -/// -public struct WeakErased { - private var _value: () -> Value? - - /// The type-erased or otherwise mapped version of the value being held weakly. - public var wrappedValue: Value? { - _value() - } -} - -#endif - -extension WeakErased { - - /// - /// Create a `WeakErased` wrapper using an initial value and a closure to create the type-erased object. - /// Make sure to not create a `WeakErased` wrapper for already type-erased objects, - /// since their reference is most likely instantly lost. - /// - public init(_ value: Erasable, erase: @escaping (Erasable) -> Value) { - self._value = WeakErased.createValueClosure(for: value, erase: erase) - } - - /// - /// Set a new value by providing a non-type-erased value and a closure to create the type-erased object. - /// - public mutating func set(_ value: Erasable, erase: @escaping (Erasable) -> Value) { - self._value = WeakErased.createValueClosure(for: value, erase: erase) - } - - private static func createValueClosure( - for value: Erasable, - erase: @escaping (Erasable) -> Value) -> () -> Value? { - { [weak value] in value.map(erase) } - } - -} diff --git a/Sources/XCoordinator/XCoordinator.docc/Documentation.md b/Sources/XCoordinator/XCoordinator.docc/Documentation.md new file mode 100644 index 00000000..80ecc62c --- /dev/null +++ b/Sources/XCoordinator/XCoordinator.docc/Documentation.md @@ -0,0 +1,331 @@ +# ``XCoordinator`` + +Type-safe, enum-driven navigation for UIKit and SwiftUI based on the Coordinator pattern. + +## Overview + +XCoordinator decouples navigation from view controllers and view models. You describe a flow as a `Route` enum, and a corresponding `Coordinator` decides which `Transition` to perform for each route. The result is reusable views, view models without navigation logic, and a single place to evolve the flow of your app. + +XCoordinator is especially well-suited to MVVM-C (Model-View-ViewModel-Coordinator) and ships with first-class interop for both UIKit and SwiftUI. + +For a longer prose introduction, motivation, and install instructions, see the [README on GitHub](https://github.com/quickbirdstudios/XCoordinator#readme). + +## Getting started + +Define a route enum and a coordinator that prepares a transition for each case: + +```swift +enum UserListRoute: Route { + case home + case user(String) + case logout +} + +class UserListCoordinator: NavigationCoordinator { + init() { + super.init(initialRoute: .home) + } + + @TransitionBuilder + override func prepareTransition(for route: UserListRoute) -> NavigationTransition { + switch route { + case .home: + Transition.push(HomeViewController()) + case .user(let name): + Transition.present(UserCoordinator(user: name), animation: .default) + case .logout: + Transition.dismiss() + } + } +} +``` + +The classic style — a plain `prepareTransition(for:)` (no attribute) returning `Transition.…` factories — +remains fully supported and non-breaking; see . + +Trigger routes from a view model that holds a typed router reference: + +```swift +class HomeViewModel { + unowned let router: any Router + + init(router: any Router) { + self.router = router + } + + func usersButtonPressed() { + router.trigger(.users) + } +} +``` + +Bootstrap the initial coordinator from your app delegate or `@main` entry point, and hold it via a strong `any Router`: + +```swift +@UIApplicationMain +class AppDelegate: UIResponder, UIApplicationDelegate { + let window: UIWindow! = UIWindow() + let router: any Router = AppCoordinator() + + func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { + router.setRoot(for: window) + return true + } +} +``` + +## Building transitions + +There are two supported ways to define the transition for a route — both produce a `Transition`. + +### The transition builder (recommended, new in 3.0) + +Annotate your override with `@TransitionBuilder` to compose transitions declaratively. +The builder operates on ``Transition`` values, so its body simply lists the `Transition.…` factories that +apply to the coordinator's root view controller — `.push(_:)`, `.present(_:)`, `.dismiss()`, `.set(_:)`, +`.select(_:)`, `.deepLink(_:_:)`, `.withAnimation { … }`, `.none()`, … Listing several in one block chains +them in order (equivalent to `.multiple`). + +```swift +class AppCoordinator: NavigationCoordinator { + @TransitionBuilder + override func prepareTransition(for route: AppRoute) -> NavigationTransition { + switch route { + case .home: + Transition.push(HomeViewController()) + case .detail(let id): + Transition.push(DetailViewController(id: id)) + case .reset: + Transition.popToRoot() // list several to combine them (like `.multiple`) + Transition.push(HomeViewController()) + case .ignored: + Transition.none() // an empty builder block is a compile-time error + } + } +} +``` + +> Note: Swift does not inherit a result-builder attribute onto an override, so you must restate +> `@TransitionBuilder` on each override that uses builder syntax. + +The same builder closure is accepted anywhere a transition is expected — ``BasicCoordinator``'s initializer, +`performTransition(_:)`, `Transition.perform(on:_:)`, and the `initialTransition:` initializers. + +### The classic style (still supported, non-breaking) + +A plain `prepareTransition(for:)` (no attribute) that returns `Transition.…` factories works exactly as it +did in 2.x — nothing to migrate: + +```swift +class AppCoordinator: NavigationCoordinator { + override func prepareTransition(for route: AppRoute) -> NavigationTransition { + switch route { + case .home: .push(HomeViewController()) + case .detail(let id): .push(DetailViewController(id: id)) + case .reset: .multiple(.popToRoot(), .push(HomeViewController())) + } + } +} +``` + +## Choosing a router reference + +Since 3.0, type erasure is provided by Swift's parameterized existential `any Router`. There are no longer dedicated `AnyRouter`, `StrongRouter`, `UnownedRouter`, or `WeakRouter` types — you simply choose the ARC qualifier that matches the lifetime relationship: + +```swift +let strongRouter: any Router = ... // own the coordinator +weak var weakRouter: (any Router)? = ... // sibling/parent reference +unowned let unownedRouter: any Router = ... // child holding parent +``` + +- **strong** — the app delegate or whatever object owns the coordinator's lifetime; also used to retain child coordinators. +- **weak** — view models or view controllers holding a coordinator they do not own (sibling or parent). +- **unowned** — same use case as weak, when you can guarantee the coordinator outlives the holder. + +## SwiftUI interop + +XCoordinator integrates with SwiftUI in two directions. + +**Embed a coordinator-driven flow inside SwiftUI** with `WrappedRouter`. The closure builds the coordinator the first time the view appears; the coordinator instance is retained for the lifetime of the view: + +```swift +struct ContentView: View { + var body: some View { + WrappedRouter { + UsersCoordinator() + } + } +} +``` + +**Push or present a SwiftUI view from a UIKit coordinator** with `RoutingController`, a `UIHostingController` subclass that propagates the current `RoutingContext` into the SwiftUI environment: + +```swift +class UsersCoordinator: NavigationCoordinator { + override func prepareTransition(for route: UserRoute) -> NavigationTransition { + switch route { + case .user(let name): + return .push(RoutingController { UserView(name: name) }) + } + } +} +``` + +**Trigger routes from inside a SwiftUI view** with the `@Routing` property wrapper. It reads the nearest router for the given route type from the environment: + +```swift +struct ChildView: View { + @Routing var usersRouter + + var body: some View { + Button("Open") { usersRouter.trigger(.user("Bob")) } + } +} +``` + +**Drive SwiftUI state changes from `prepareTransition(for:)`** with `Transition.withAnimation` or `Transition.withTransaction`, which run a body closure inside `SwiftUI.withAnimation`/`withTransaction` without performing any UIKit transition: + +```swift +class HomeCoordinator: TabBarCoordinator { + @Binding var selection: HomeTab + + override func prepareTransition(for route: HomeRoute) -> TabBarTransition { + switch route { + case .select(let tab): + return .withAnimation { selection = tab } + } + } +} +``` + +For declarative, condition-driven triggering, the `triggerOnAppear`, `triggerOnChange(of:)`, and `trigger(when:)` view modifiers let a SwiftUI view fire routes through `@Routing` automatically. + +## Custom transitions + +You can supply custom `Animation` objects to common transitions (`push`, `pop`, `present`, `dismiss`). Passing `nil` keeps the previously configured animation; `Animation.default` resets to UIKit defaults. + +```swift +let animation = Animation( + presentationAnimation: MyPresentation(), + dismissalAnimation: MyDismissal() +) +return .push(viewController, animation: animation) +``` + +For interactive transitions driven by gesture recognizers, see ``BaseCoordinator/registerInteractiveTransition(for:triggeredBy:handler:completion:)`` and its progress-based overload. + +## Deep linking + +Chain routes across coordinator boundaries using `deepLink(_:_:)`. The deep link walks the coordinator tree via ``Presentable/router(for:)``, switching to whichever router can handle the next route type: + +```swift +return deepLink(AppRoute.login, AppRoute.home, HomeRoute.news, HomeRoute.dismiss) +``` + +> Important: Deep links are not checked at compile time. If a router for one of the chained route types cannot be located at runtime, the framework triggers an `assertionFailure`. Keep this in mind whenever you reshape the coordinator hierarchy. + +## RedirectionRouter + +When a route enum has grown too large but you cannot introduce a new root view controller, ``RedirectionRouter`` lets you split a child route type onto a parent route type without owning its own transition type: + +```swift +class ChildCoordinator: RedirectionRouter { + init(parent: any Router) { + super.init(viewController: UIViewController(), parent: parent, map: nil) + } + + override func mapToParentRoute(for route: ChildRoute) -> ParentRoute { + // map ChildRoute cases onto ParentRoute cases + } +} +``` + +## Combine and RxSwift + +The Combine extensions ship in the main `XCoordinator` module. Use `router.publishers.trigger(_:)` to obtain a publisher that performs the route's transition on subscription and completes when it finishes: + +```swift +router.publishers.trigger(.home) + .sink { /* transition finished */ } +``` + +> Note: The returned publisher is lazy — the transition is performed when you subscribe (e.g. `.sink`), not when the publisher is created. + +For RxSwift, add the `XCoordinatorRx` product. The `router.rx.trigger(_:)` accessor returns an `Observable`: + +```swift +router.rx.trigger(.home) + .flatMap { [unowned self] in self.router.rx.trigger(.news) } +``` + +## Transition types + +The available transitions depend on the coordinator's `RootViewController` type. Common transitions across every coordinator: + +- `present` / `presentOnRoot` — present on top of the view hierarchy +- `dismiss` / `dismissToRoot` +- `embed` — embed a view controller in a container (any ``Container`` — both `UIView` and `UIViewController` conform) +- `none` — no-op (useful in tests or to ignore routes) + +`NavigationTransition` (``NavigationCoordinator``) additionally provides `push`, `pop`, and `popToRoot`. ``TabBarCoordinator``, ``SplitCoordinator``, and ``PageCoordinator`` each provide transitions specific to their root view controller. + +## Topics + +### Coordinators + +- ``Coordinator`` +- ``BaseCoordinator`` +- ``ViewCoordinator`` +- ``NavigationCoordinator`` +- ``TabBarCoordinator`` +- ``SplitCoordinator`` +- ``PageCoordinator`` +- ``BasicCoordinator`` +- ``RedirectionRouter`` + +### Routes and routing + +- ``Route`` +- ``Router`` +- ``Presentable`` + +### Transitions + +- ``Transition`` +- ``TransitionContext`` +- ``TransitionOptions`` +- ``Container`` +- ``NavigationTransition`` +- ``TabBarTransition`` +- ``SplitTransition`` +- ``PageTransition`` +- ``ViewTransition`` + +### Transition builder + +- ``TransitionBuilder`` + +### Animations + +- ``Animation`` +- ``TransitionAnimation`` +- ``StaticTransitionAnimation`` +- ``InteractiveTransitionAnimation`` +- ``InterruptibleTransitionAnimation`` +- ``PercentDrivenInteractionController`` +- ``NavigationAnimationDelegate`` +- ``TabBarAnimationDelegate`` +- ``PageCoordinatorDataSource`` + +### Combine + +- ``PublisherExtension`` + +### SwiftUI + +- ``Routing`` +- ``RoutingContext`` +- ``RoutingContextProvider`` +- ``RoutingController`` +- ``WrappedRouter`` +- ``RepresentableContext`` diff --git a/Sources/XCoordinatorCombine/Router+Combine.swift b/Sources/XCoordinatorCombine/Router+Combine.swift deleted file mode 100644 index 9b9136aa..00000000 --- a/Sources/XCoordinatorCombine/Router+Combine.swift +++ /dev/null @@ -1,50 +0,0 @@ -// -// Router+Combine.swift -// XCoordinatorCombine -// -// Created by Paul Kraft on 28.08.19. -// Copyright © 2018 QuickBird Studios. All rights reserved. -// - -#if canImport(Combine) && canImport(XCoordinator) - -import Combine -import XCoordinator - -public struct PublisherExtension { - public let base: Base -} - -extension Router { - - public var publishers: PublisherExtension { - .init(base: self) - } - - @available(iOS 13.0, tvOS 13.0, *) - public func triggerPublisher( - _ route: RouteType, - with options: TransitionOptions = .init(animated: true) - ) -> Future { - Future { completion in - self.trigger(route, with: options) { - completion(.success(())) - } - } - } - -} - -@available(iOS 13.0, tvOS 13.0, *) -extension PublisherExtension where Base: Router { - - public func trigger( - _ route: Base.RouteType, - with options: TransitionOptions = .init(animated: true) - ) -> Future { - base.triggerPublisher(route, with: options) - } - -} - -#endif diff --git a/Sources/XCoordinatorRx/Router+Rx.swift b/Sources/XCoordinatorRx/Router+Rx.swift index 43760301..6cb2732a 100644 --- a/Sources/XCoordinatorRx/Router+Rx.swift +++ b/Sources/XCoordinatorRx/Router+Rx.swift @@ -8,33 +8,54 @@ #if canImport(XCoordinator) && canImport(RxSwift) -import XCoordinator import RxSwift +import XCoordinator + +/// +/// A namespace for RxSwift observables exposed by a `Router`. +/// +/// Routers expose this namespace via ``Router/rx``, mirroring the `Router.publishers` Combine namespace. +/// Use the methods on this type — `trigger(_:with:)` and `contextTrigger(_:with:)` — to obtain +/// observables that emit when transitions complete. +/// +@MainActor +public struct ReactiveRouter { + + // MARK: Stored Properties + + fileprivate let base: any Router + + // MARK: Initialization + + fileprivate init(_ base: any Router) { + self.base = base + } + +} extension Router { /// Use this to access the reactive extensions of `Router` objects. - public var rx: Reactive { + public var rx: ReactiveRouter { // swiftlint:disable:previous identifier_name - Reactive(self) + ReactiveRouter(self) } + } -extension Reactive where Base: Router { +extension ReactiveRouter { + + // MARK: Convenience methods /// - /// This method transforms the completion block of a router's trigger method into an observable. - /// - /// - Parameter route: - /// The route to be triggered. - /// - /// - Parameter options: - /// Transition options, e.g. defining whether or not the transition should be animated. + /// Wraps a route trigger in an `Observable` that emits once the transition has completed. /// - /// - Returns: - /// An observable informing about the completion of the transition. + /// - Parameters: + /// - route: The route to trigger. + /// - options: Transition options. Defaults to animated. + /// - Returns: An observable emitting `()` and then completing when the transition finishes. /// - public func trigger(_ route: Base.RouteType, with options: TransitionOptions) -> Observable { + public func trigger(_ route: RouteType, with options: TransitionOptions = .init(animated: true)) -> Observable { Observable.create { [base] observer -> Disposable in base.trigger(route, with: options) { observer.onNext(()) @@ -44,22 +65,30 @@ extension Reactive where Base: Router { } } - // MARK: Convenience methods - - /// - /// This method transforms the completion block of a router's trigger method into an observable. /// - /// It uses the default transition options as specified in `Router.trigger`. + /// Wraps a route trigger in an `Observable` that emits the resulting + /// transition context once the transition has completed. /// - /// - Parameter route: - /// The route to be triggered. + /// Useful for deep linking when the resulting context is required for further processing. /// - /// - Returns: - /// An observable informing about the completion of the transition. + /// - Parameters: + /// - route: The route to trigger. + /// - options: Transition options. Defaults to animated. + /// - Returns: An observable emitting the transition context and then completing. /// - public func trigger(_ route: Base.RouteType) -> Observable { - trigger(route, with: TransitionOptions(animated: true)) + public func contextTrigger( + _ route: RouteType, + with options: TransitionOptions = .init(animated: true) + ) -> Observable { + Observable.create { [base] observer -> Disposable in + base.contextTrigger(route, with: options) { + observer.onNext($0) + observer.onCompleted() + } + return Disposables.create() + } } + } #endif diff --git a/Sources/ios.xcconfig b/Sources/ios.xcconfig deleted file mode 100644 index 3a928f37..00000000 --- a/Sources/ios.xcconfig +++ /dev/null @@ -1,10 +0,0 @@ -SDKROOT = iphoneos -SUPPORTED_PLATFORMS = iphonesimulator iphoneos -IPHONEOS_DEPLOYMENT_TARGET = 12.0 - -ARCHS = $(ARCHS_STANDARD) -VALID_ARCHS = $(ARCHS_STANDARD) - -VALIDATE_PRODUCT = YES -LD_RUNPATH_SEARCH_PATHS = $(inherited) @executable_path/Frameworks -TARGETED_DEVICE_FAMILY = 1, 2 diff --git a/TestHost/App/AppDelegate.swift b/TestHost/App/AppDelegate.swift new file mode 100644 index 00000000..8c681247 --- /dev/null +++ b/TestHost/App/AppDelegate.swift @@ -0,0 +1,32 @@ +// +// AppDelegate.swift +// XCoordinatorTestHost +// +// Minimal scene-based host application for running XCoordinatorTests. +// UIKit view-controller presentation only works when a real UIWindowScene +// exists, which a bare SwiftPM test bundle does not provide — hence this host. +// + +import UIKit + +@main +final class AppDelegate: UIResponder, UIApplicationDelegate { + + func application( + _ application: UIApplication, + didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil + ) -> Bool { + true + } + + func application( + _ application: UIApplication, + configurationForConnecting connectingSceneSession: UISceneSession, + options: UIScene.ConnectionOptions + ) -> UISceneConfiguration { + let configuration = UISceneConfiguration(name: "Default", sessionRole: connectingSceneSession.role) + configuration.delegateClass = SceneDelegate.self + return configuration + } + +} diff --git a/TestHost/App/Info.plist b/TestHost/App/Info.plist new file mode 100644 index 00000000..c8f750a0 --- /dev/null +++ b/TestHost/App/Info.plist @@ -0,0 +1,25 @@ + + + + + UIApplicationSceneManifest + + UIApplicationSupportsMultipleScenes + + UISceneConfigurations + + UIWindowSceneSessionRoleApplication + + + UISceneConfigurationName + Default + UISceneDelegateClassName + $(PRODUCT_MODULE_NAME).SceneDelegate + + + + + UILaunchScreen + + + diff --git a/TestHost/App/SceneDelegate.swift b/TestHost/App/SceneDelegate.swift new file mode 100644 index 00000000..2b88a2be --- /dev/null +++ b/TestHost/App/SceneDelegate.swift @@ -0,0 +1,24 @@ +// +// SceneDelegate.swift +// XCoordinatorTestHost +// + +import UIKit + +final class SceneDelegate: UIResponder, UIWindowSceneDelegate { + + var window: UIWindow? + + func scene( + _ scene: UIScene, + willConnectTo session: UISceneSession, + options connectionOptions: UIScene.ConnectionOptions + ) { + guard let windowScene = scene as? UIWindowScene else { return } + let window = UIWindow(windowScene: windowScene) + window.rootViewController = UIViewController() + window.makeKeyAndVisible() + self.window = window + } + +} diff --git a/TestHost/XCoordinatorTestHost.xcodeproj/project.pbxproj b/TestHost/XCoordinatorTestHost.xcodeproj/project.pbxproj new file mode 100644 index 00000000..969f9d12 --- /dev/null +++ b/TestHost/XCoordinatorTestHost.xcodeproj/project.pbxproj @@ -0,0 +1,450 @@ +// !$*UTF8*$! +{ + archiveVersion = 1; + classes = { + }; + objectVersion = 56; + objects = { + +/* Begin PBXBuildFile section */ + 0A0000000000000000000030 /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0A0000000000000000000010 /* AppDelegate.swift */; }; + 0A0000000000000000000031 /* SceneDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0A0000000000000000000011 /* SceneDelegate.swift */; }; + 0A0000000000000000000040 /* AnimationTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0A0000000000000000000020 /* AnimationTests.swift */; }; + 0A0000000000000000000041 /* TestAnimation.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0A0000000000000000000021 /* TestAnimation.swift */; }; + 0A0000000000000000000042 /* TestRoute.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0A0000000000000000000022 /* TestRoute.swift */; }; + 0A0000000000000000000043 /* TransitionTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0A0000000000000000000023 /* TransitionTests.swift */; }; + 0A0000000000000000000044 /* XCTest+Extras.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0A0000000000000000000024 /* XCTest+Extras.swift */; }; + 0A0000000000000000000045 /* SwiftUIRoutingTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0A0000000000000000000025 /* SwiftUIRoutingTests.swift */; }; + 0A0000000000000000000046 /* TriggerModifierTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0A0000000000000000000026 /* TriggerModifierTests.swift */; }; + 0A0000000000000000000047 /* TransitionSwiftUITests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0A0000000000000000000027 /* TransitionSwiftUITests.swift */; }; + 0A0000000000000000000048 /* TransitionBuilderTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0A0000000000000000000028 /* TransitionBuilderTests.swift */; }; + 0A0000000000000000000049 /* AsyncCombineTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0A0000000000000000000029 /* AsyncCombineTests.swift */; }; + 0A000000000000000000004A /* TabSplitBindingTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0A000000000000000000002A /* TabSplitBindingTests.swift */; }; + 0A000000000000000000004B /* CoordinatorChildLifecycleTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0A000000000000000000002B /* CoordinatorChildLifecycleTests.swift */; }; + 0A000000000000000000004C /* ContextMenuInteractionTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0A000000000000000000002C /* ContextMenuInteractionTests.swift */; }; + 0A0000000000000000000050 /* XCoordinator in Frameworks */ = {isa = PBXBuildFile; productRef = 0A00000000000000000000A1 /* XCoordinator */; }; +/* End PBXBuildFile section */ + +/* Begin PBXContainerItemProxy section */ + 0A00000000000000000000B1 /* PBXContainerItemProxy */ = { + isa = PBXContainerItemProxy; + containerPortal = 0A0000000000000000000001 /* Project object */; + proxyType = 1; + remoteGlobalIDString = 0A0000000000000000000060; + remoteInfo = XCoordinatorTestHost; + }; +/* End PBXContainerItemProxy section */ + +/* Begin PBXFileReference section */ + 0A0000000000000000000010 /* AppDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppDelegate.swift; sourceTree = ""; }; + 0A0000000000000000000011 /* SceneDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SceneDelegate.swift; sourceTree = ""; }; + 0A0000000000000000000012 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = ""; }; + 0A0000000000000000000013 /* XCoordinatorTestHost.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = XCoordinatorTestHost.app; sourceTree = BUILT_PRODUCTS_DIR; }; + 0A0000000000000000000014 /* XCoordinatorTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = XCoordinatorTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; }; + 0A0000000000000000000020 /* AnimationTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AnimationTests.swift; sourceTree = ""; }; + 0A0000000000000000000021 /* TestAnimation.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TestAnimation.swift; sourceTree = ""; }; + 0A0000000000000000000022 /* TestRoute.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TestRoute.swift; sourceTree = ""; }; + 0A0000000000000000000023 /* TransitionTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TransitionTests.swift; sourceTree = ""; }; + 0A0000000000000000000024 /* XCTest+Extras.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "XCTest+Extras.swift"; sourceTree = ""; }; + 0A0000000000000000000025 /* SwiftUIRoutingTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SwiftUIRoutingTests.swift; sourceTree = ""; }; + 0A0000000000000000000026 /* TriggerModifierTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TriggerModifierTests.swift; sourceTree = ""; }; + 0A0000000000000000000027 /* TransitionSwiftUITests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TransitionSwiftUITests.swift; sourceTree = ""; }; + 0A0000000000000000000028 /* TransitionBuilderTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TransitionBuilderTests.swift; sourceTree = ""; }; + 0A0000000000000000000029 /* AsyncCombineTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AsyncCombineTests.swift; sourceTree = ""; }; + 0A000000000000000000002A /* TabSplitBindingTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TabSplitBindingTests.swift; sourceTree = ""; }; + 0A000000000000000000002B /* CoordinatorChildLifecycleTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CoordinatorChildLifecycleTests.swift; sourceTree = ""; }; + 0A000000000000000000002C /* ContextMenuInteractionTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ContextMenuInteractionTests.swift; sourceTree = ""; }; +/* End PBXFileReference section */ + +/* Begin PBXFrameworksBuildPhase section */ + 0A0000000000000000000071 /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 0A0000000000000000000074 /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + 0A0000000000000000000050 /* XCoordinator in Frameworks */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXFrameworksBuildPhase section */ + +/* Begin PBXGroup section */ + 0A0000000000000000000002 = { + isa = PBXGroup; + children = ( + 0A0000000000000000000004 /* App */, + 0A0000000000000000000005 /* XCoordinatorTests */, + 0A0000000000000000000003 /* Products */, + ); + sourceTree = ""; + }; + 0A0000000000000000000003 /* Products */ = { + isa = PBXGroup; + children = ( + 0A0000000000000000000013 /* XCoordinatorTestHost.app */, + 0A0000000000000000000014 /* XCoordinatorTests.xctest */, + ); + name = Products; + sourceTree = ""; + }; + 0A0000000000000000000004 /* App */ = { + isa = PBXGroup; + children = ( + 0A0000000000000000000010 /* AppDelegate.swift */, + 0A0000000000000000000011 /* SceneDelegate.swift */, + 0A0000000000000000000012 /* Info.plist */, + ); + path = App; + sourceTree = ""; + }; + 0A0000000000000000000005 /* XCoordinatorTests */ = { + isa = PBXGroup; + children = ( + 0A0000000000000000000020 /* AnimationTests.swift */, + 0A0000000000000000000021 /* TestAnimation.swift */, + 0A0000000000000000000022 /* TestRoute.swift */, + 0A0000000000000000000023 /* TransitionTests.swift */, + 0A0000000000000000000024 /* XCTest+Extras.swift */, + 0A0000000000000000000025 /* SwiftUIRoutingTests.swift */, + 0A0000000000000000000026 /* TriggerModifierTests.swift */, + 0A0000000000000000000027 /* TransitionSwiftUITests.swift */, + 0A0000000000000000000028 /* TransitionBuilderTests.swift */, + 0A0000000000000000000029 /* AsyncCombineTests.swift */, + 0A000000000000000000002A /* TabSplitBindingTests.swift */, + 0A000000000000000000002B /* CoordinatorChildLifecycleTests.swift */, + 0A000000000000000000002C /* ContextMenuInteractionTests.swift */, + ); + name = XCoordinatorTests; + path = ../Tests/XCoordinatorTests; + sourceTree = ""; + }; +/* End PBXGroup section */ + +/* Begin PBXNativeTarget section */ + 0A0000000000000000000060 /* XCoordinatorTestHost */ = { + isa = PBXNativeTarget; + buildConfigurationList = 0A0000000000000000000081 /* Build configuration list for PBXNativeTarget "XCoordinatorTestHost" */; + buildPhases = ( + 0A0000000000000000000070 /* Sources */, + 0A0000000000000000000071 /* Frameworks */, + 0A0000000000000000000072 /* Resources */, + ); + buildRules = ( + ); + dependencies = ( + ); + name = XCoordinatorTestHost; + packageProductDependencies = ( + ); + productName = XCoordinatorTestHost; + productReference = 0A0000000000000000000013 /* XCoordinatorTestHost.app */; + productType = "com.apple.product-type.application"; + }; + 0A0000000000000000000061 /* XCoordinatorTests */ = { + isa = PBXNativeTarget; + buildConfigurationList = 0A0000000000000000000082 /* Build configuration list for PBXNativeTarget "XCoordinatorTests" */; + buildPhases = ( + 0A0000000000000000000073 /* Sources */, + 0A0000000000000000000074 /* Frameworks */, + 0A0000000000000000000075 /* Resources */, + ); + buildRules = ( + ); + dependencies = ( + 0A00000000000000000000B0 /* PBXTargetDependency */, + ); + name = XCoordinatorTests; + packageProductDependencies = ( + 0A00000000000000000000A1 /* XCoordinator */, + ); + productName = XCoordinatorTests; + productReference = 0A0000000000000000000014 /* XCoordinatorTests.xctest */; + productType = "com.apple.product-type.bundle.unit-test"; + }; +/* End PBXNativeTarget section */ + +/* Begin PBXProject section */ + 0A0000000000000000000001 /* Project object */ = { + isa = PBXProject; + attributes = { + BuildIndependentTargetsInParallel = 1; + LastSwiftUpdateCheck = 1540; + LastUpgradeCheck = 1540; + TargetAttributes = { + 0A0000000000000000000060 = { + CreatedOnToolsVersion = 15.4; + }; + 0A0000000000000000000061 = { + CreatedOnToolsVersion = 15.4; + TestTargetID = 0A0000000000000000000060; + }; + }; + }; + buildConfigurationList = 0A0000000000000000000080 /* Build configuration list for PBXProject "XCoordinatorTestHost" */; + compatibilityVersion = "Xcode 14.0"; + developmentRegion = en; + hasScannedForEncodings = 0; + knownRegions = ( + en, + Base, + ); + mainGroup = 0A0000000000000000000002; + packageReferences = ( + 0A00000000000000000000A0 /* XCLocalSwiftPackageReference "XCoordinator" */, + ); + productRefGroup = 0A0000000000000000000003 /* Products */; + projectDirPath = ""; + projectRoot = ""; + targets = ( + 0A0000000000000000000060 /* XCoordinatorTestHost */, + 0A0000000000000000000061 /* XCoordinatorTests */, + ); + }; +/* End PBXProject section */ + +/* Begin PBXResourcesBuildPhase section */ + 0A0000000000000000000072 /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 0A0000000000000000000075 /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXResourcesBuildPhase section */ + +/* Begin PBXSourcesBuildPhase section */ + 0A0000000000000000000070 /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 0A0000000000000000000030 /* AppDelegate.swift in Sources */, + 0A0000000000000000000031 /* SceneDelegate.swift in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 0A0000000000000000000073 /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 0A0000000000000000000040 /* AnimationTests.swift in Sources */, + 0A0000000000000000000041 /* TestAnimation.swift in Sources */, + 0A0000000000000000000042 /* TestRoute.swift in Sources */, + 0A0000000000000000000043 /* TransitionTests.swift in Sources */, + 0A0000000000000000000044 /* XCTest+Extras.swift in Sources */, + 0A0000000000000000000045 /* SwiftUIRoutingTests.swift in Sources */, + 0A0000000000000000000046 /* TriggerModifierTests.swift in Sources */, + 0A0000000000000000000047 /* TransitionSwiftUITests.swift in Sources */, + 0A0000000000000000000048 /* TransitionBuilderTests.swift in Sources */, + 0A0000000000000000000049 /* AsyncCombineTests.swift in Sources */, + 0A000000000000000000004A /* TabSplitBindingTests.swift in Sources */, + 0A000000000000000000004B /* CoordinatorChildLifecycleTests.swift in Sources */, + 0A000000000000000000004C /* ContextMenuInteractionTests.swift in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXSourcesBuildPhase section */ + +/* Begin PBXTargetDependency section */ + 0A00000000000000000000B0 /* PBXTargetDependency */ = { + isa = PBXTargetDependency; + target = 0A0000000000000000000060 /* XCoordinatorTestHost */; + targetProxy = 0A00000000000000000000B1 /* PBXContainerItemProxy */; + }; +/* End PBXTargetDependency section */ + +/* Begin XCBuildConfiguration section */ + 0A0000000000000000000090 /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + CLANG_ANALYZER_NONNULL = YES; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + COPY_PHASE_STRIP = NO; + DEBUG_INFORMATION_FORMAT = dwarf; + ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_TESTABILITY = YES; + GCC_DYNAMIC_NO_PIC = NO; + GCC_OPTIMIZATION_LEVEL = 0; + GCC_PREPROCESSOR_DEFINITIONS = ( + "DEBUG=1", + "$(inherited)", + ); + IPHONEOS_DEPLOYMENT_TARGET = 16.0; + MTL_ENABLE_DEBUG_INFO = INCLUDE_SOURCE; + ONLY_ACTIVE_ARCH = YES; + SDKROOT = iphoneos; + SWIFT_ACTIVE_COMPILATION_CONDITIONS = DEBUG; + SWIFT_OPTIMIZATION_LEVEL = "-Onone"; + SWIFT_VERSION = 5.0; + }; + name = Debug; + }; + 0A0000000000000000000091 /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + CLANG_ANALYZER_NONNULL = YES; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + COPY_PHASE_STRIP = NO; + DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + ENABLE_NS_ASSERTIONS = NO; + ENABLE_STRICT_OBJC_MSGSEND = YES; + IPHONEOS_DEPLOYMENT_TARGET = 16.0; + MTL_ENABLE_DEBUG_INFO = NO; + SDKROOT = iphoneos; + SWIFT_COMPILATION_MODE = wholemodule; + SWIFT_OPTIMIZATION_LEVEL = "-O"; + SWIFT_VERSION = 5.0; + VALIDATE_PRODUCT = YES; + }; + name = Release; + }; + 0A0000000000000000000092 /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + ASSETCATALOG_COMPILER_GENERATE_ASSET_SYMBOLS = NO; + CODE_SIGN_STYLE = Automatic; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + INFOPLIST_FILE = App/Info.plist; + INFOPLIST_KEY_UIApplicationSupportsIndirectInputEvents = YES; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/Frameworks", + ); + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = studios.quickbird.XCoordinatorTestHost; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_EMIT_LOC_STRINGS = YES; + TARGETED_DEVICE_FAMILY = "1,2"; + }; + name = Debug; + }; + 0A0000000000000000000093 /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + ASSETCATALOG_COMPILER_GENERATE_ASSET_SYMBOLS = NO; + CODE_SIGN_STYLE = Automatic; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + INFOPLIST_FILE = App/Info.plist; + INFOPLIST_KEY_UIApplicationSupportsIndirectInputEvents = YES; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/Frameworks", + ); + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = studios.quickbird.XCoordinatorTestHost; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_EMIT_LOC_STRINGS = YES; + TARGETED_DEVICE_FAMILY = "1,2"; + }; + name = Release; + }; + 0A0000000000000000000094 /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CODE_SIGN_STYLE = Automatic; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + IPHONEOS_DEPLOYMENT_TARGET = 16.0; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/Frameworks", + "@loader_path/Frameworks", + ); + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = studios.quickbird.XCoordinatorTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_EMIT_LOC_STRINGS = NO; + TARGETED_DEVICE_FAMILY = "1,2"; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/XCoordinatorTestHost.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/XCoordinatorTestHost"; + }; + name = Debug; + }; + 0A0000000000000000000095 /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CODE_SIGN_STYLE = Automatic; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + IPHONEOS_DEPLOYMENT_TARGET = 16.0; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/Frameworks", + "@loader_path/Frameworks", + ); + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = studios.quickbird.XCoordinatorTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_EMIT_LOC_STRINGS = NO; + TARGETED_DEVICE_FAMILY = "1,2"; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/XCoordinatorTestHost.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/XCoordinatorTestHost"; + }; + name = Release; + }; +/* End XCBuildConfiguration section */ + +/* Begin XCConfigurationList section */ + 0A0000000000000000000080 /* Build configuration list for PBXProject "XCoordinatorTestHost" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 0A0000000000000000000090 /* Debug */, + 0A0000000000000000000091 /* Release */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 0A0000000000000000000081 /* Build configuration list for PBXNativeTarget "XCoordinatorTestHost" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 0A0000000000000000000092 /* Debug */, + 0A0000000000000000000093 /* Release */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 0A0000000000000000000082 /* Build configuration list for PBXNativeTarget "XCoordinatorTests" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 0A0000000000000000000094 /* Debug */, + 0A0000000000000000000095 /* Release */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; +/* End XCConfigurationList section */ + +/* Begin XCLocalSwiftPackageReference section */ + 0A00000000000000000000A0 /* XCLocalSwiftPackageReference "XCoordinator" */ = { + isa = XCLocalSwiftPackageReference; + relativePath = ..; + }; +/* End XCLocalSwiftPackageReference section */ + +/* Begin XCSwiftPackageProductDependency section */ + 0A00000000000000000000A1 /* XCoordinator */ = { + isa = XCSwiftPackageProductDependency; + productName = XCoordinator; + }; +/* End XCSwiftPackageProductDependency section */ + }; + rootObject = 0A0000000000000000000001 /* Project object */; +} diff --git a/XCoordinator.xcodeproj/xcshareddata/xcschemes/XCoordinator.xcscheme b/TestHost/XCoordinatorTestHost.xcodeproj/xcshareddata/xcschemes/XCoordinatorTestHost.xcscheme similarity index 55% rename from XCoordinator.xcodeproj/xcshareddata/xcschemes/XCoordinator.xcscheme rename to TestHost/XCoordinatorTestHost.xcodeproj/xcshareddata/xcschemes/XCoordinatorTestHost.xcscheme index 0df84226..b33b7a93 100644 --- a/XCoordinator.xcodeproj/xcshareddata/xcschemes/XCoordinator.xcscheme +++ b/TestHost/XCoordinatorTestHost.xcodeproj/xcshareddata/xcschemes/XCoordinatorTestHost.xcscheme @@ -1,6 +1,6 @@ + BlueprintIdentifier = "0A0000000000000000000060" + BuildableName = "XCoordinatorTestHost.app" + BlueprintName = "XCoordinatorTestHost" + ReferencedContainer = "container:XCoordinatorTestHost.xcodeproj"> @@ -27,8 +27,18 @@ selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB" selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB" shouldUseLaunchSchemeArgsEnv = "YES"> - - + + + + + + - - - + + BlueprintIdentifier = "0A0000000000000000000060" + BuildableName = "XCoordinatorTestHost.app" + BlueprintName = "XCoordinatorTestHost" + ReferencedContainer = "container:XCoordinatorTestHost.xcodeproj"> - - - - - - + + diff --git a/Tests/LinuxMain.swift b/Tests/LinuxMain.swift deleted file mode 100644 index ea3607a1..00000000 --- a/Tests/LinuxMain.swift +++ /dev/null @@ -1,7 +0,0 @@ -import XCTest - -import XCoordinatorTests - -var tests = [XCTestCaseEntry]() -tests += XCoordinatorTests.allTests() -XCTMain(tests) diff --git a/Tests/XCoordinatorTests/AnimationTests.swift b/Tests/XCoordinatorTests/AnimationTests.swift index cfbef18a..6c287be6 100644 --- a/Tests/XCoordinatorTests/AnimationTests.swift +++ b/Tests/XCoordinatorTests/AnimationTests.swift @@ -10,21 +10,12 @@ import UIKit import XCoordinator import XCTest +@MainActor class AnimationTests: XCTestCase { - // MARK: Static properties - - static let allTests = [ - ("testPageCoordinator", testPageCoordinator), - ("testSplitCoordinator", testSplitCoordinator), - ("testTabBarCoordinator", testTabBarCoordinator), - ("testViewCoordinator", testViewCoordinator), - ("testNavigationCoordinator", testNavigationCoordinator), - ] - // MARK: Stored properties - lazy var window = UIWindow() + lazy var window = makeWindow() // MARK: Tests @@ -35,7 +26,7 @@ class AnimationTests: XCTestCase { } func testSplitCoordinator() { - let coordinator = SplitCoordinator(master: UIViewController(), detail: UIViewController()) + let coordinator = SplitCoordinator(primary: UIViewController(), secondary: UIViewController()) coordinator.setRoot(for: window) testStandardAnimationsCalled(on: coordinator) } @@ -52,13 +43,16 @@ class AnimationTests: XCTestCase { coordinator.setRoot(for: window) testStandardAnimationsCalled(on: coordinator) - testStaticAnimationCalled(on: coordinator, transition: { .select(tabs[1], animation: $0) }) + // UIKit only runs a custom tab-bar animator when an interaction controller is present, + // so the static (non-interactive) cases assert completion only, while the interactive + // cases assert the custom animation runs. + testCompletionCalled(on: coordinator, transition: { .select(tabs[1], animation: $0) }) testInteractiveAnimationCalled(on: coordinator, transition: { .select(tabs[2], animation: $0) }) - testStaticAnimationCalled(on: coordinator, transition: { .select(index: 1, animation: $0) }) + testCompletionCalled(on: coordinator, transition: { .select(index: 1, animation: $0) }) testInteractiveAnimationCalled(on: coordinator, transition: { .select(index: 2, animation: $0) }) - testStaticAnimationCalled( + testCompletionCalled( on: coordinator, transition: { .set([UIViewController(), UIViewController()], animation: $0) } ) @@ -101,7 +95,7 @@ class AnimationTests: XCTestCase { // MARK: Helpers - private func testStandardAnimationsCalled(on coordinator: C) where C.TransitionType == Transition { + private func testStandardAnimationsCalled(on coordinator: C) { testStaticAnimationCalled(on: coordinator, transition: { .present(UIViewController(), animation: $0) }) testStaticAnimationCalled(on: coordinator, transition: { .dismiss(animation: $0) }) testStaticAnimationCalled( @@ -122,7 +116,7 @@ class AnimationTests: XCTestCase { } private func testStaticAnimationCalled(on coordinator: C, - transition: (Animation) -> C.TransitionType) { + transition: (Animation) -> Transition) { let animationExpectation = expectation(description: "Animation \(Date().timeIntervalSince1970)") let completionExpectation = expectation(description: "Completion \(Date().timeIntervalSince1970)") print(#function, animationExpectation) @@ -131,12 +125,15 @@ class AnimationTests: XCTestCase { coordinator.performTransition(t, with: TransitionOptions(animated: true)) { completionExpectation.fulfill() } - wait(for: [animationExpectation, completionExpectation], timeout: 3, enforceOrder: true) + // Order is not enforced: for container transitions (tab bar / navigation) UIKit + // may invoke the animator and fire the completion in either order. What matters + // is that both happen — the animation runs and the completion is called. + wait(for: [animationExpectation, completionExpectation], timeout: 3) asyncWait(for: 0.1) } private func testInteractiveAnimationCalled(on coordinator: C, - transition: (Animation) -> C.TransitionType) { + transition: (Animation) -> Transition) { let animationExpectation = expectation(description: "Animation \(Date().timeIntervalSince1970)") let completionExpectation = expectation(description: "Completion \(Date().timeIntervalSince1970)") print(#function, animationExpectation) @@ -149,7 +146,28 @@ class AnimationTests: XCTestCase { completionExpectation.fulfill() _ = testAnimation } - wait(for: [animationExpectation, completionExpectation], timeout: 3, enforceOrder: true) + // Order is not enforced: for container transitions (tab bar / navigation) UIKit + // may invoke the animator and fire the completion in either order. What matters + // is that both happen — the animation runs and the completion is called. + wait(for: [animationExpectation, completionExpectation], timeout: 3) + asyncWait(for: 0.1) + } + + /// Verifies only that the completion handler fires. + /// + /// Used for *static* programmatic `UITabBarController` selection / `set`: UIKit only invokes + /// a custom tab-bar animator when an interaction controller is present, so for these + /// transitions iOS performs the switch without running the custom animation. The interactive + /// variants (which UIKit does animate) cover the animation wiring; here we assert the + /// transition still completes. + private func testCompletionCalled(on coordinator: C, + transition: (Animation) -> Transition) { + let completionExpectation = expectation(description: "Completion \(Date().timeIntervalSince1970)") + let t = transition(.default) + coordinator.performTransition(t, with: TransitionOptions(animated: true)) { + completionExpectation.fulfill() + } + wait(for: [completionExpectation], timeout: 3) asyncWait(for: 0.1) } } diff --git a/Tests/XCoordinatorTests/AsyncCombineTests.swift b/Tests/XCoordinatorTests/AsyncCombineTests.swift new file mode 100644 index 00000000..f1b8dbd2 --- /dev/null +++ b/Tests/XCoordinatorTests/AsyncCombineTests.swift @@ -0,0 +1,73 @@ +// +// AsyncCombineTests.swift +// XCoordinatorTests +// +// Verifies async trigger, the continuation once-guard, and lazy Combine publishers. +// + +import Combine +import UIKit +import XCoordinator +import XCTest + +/// Records how many times `prepareTransition` runs and performs a no-op transition. +@MainActor +private final class NoopCoordinator: ViewCoordinator { + + private(set) var prepareCount = 0 + + init() { + super.init(rootViewController: UIViewController()) + } + + override func prepareTransition(for route: TestRoute) -> ViewTransition { + prepareCount += 1 + return .none() + } +} + +/// Returns a transition whose perform closure invokes its completion twice. +@MainActor +private final class DoubleCompletionCoordinator: ViewCoordinator { + + init() { + super.init(rootViewController: UIViewController()) + } + + override func prepareTransition(for route: TestRoute) -> ViewTransition { + Transition(presentables: [], animationInUse: nil) { _, _, completion in + completion?() + completion?() + } + } +} + +@MainActor +final class AsyncCombineTests: XCTestCase { + + func testAsyncTriggerCompletes() async { + let coordinator = NoopCoordinator() + await coordinator.trigger(.home) + XCTAssertEqual(coordinator.prepareCount, 1) + } + + /// A transition that fires its completion twice must not crash the awaiting continuation. + func testAsyncTriggerSurvivesDoubleCompletion() async { + let coordinator = DoubleCompletionCoordinator() + _ = await coordinator.contextTrigger(.home, with: .init(animated: false)) + } + + /// `router.publishers.trigger` must be lazy: no transition until a subscriber attaches. + func testCombinePublisherIsLazy() { + let coordinator = NoopCoordinator() + let publisher = coordinator.publishers.trigger(.home) + XCTAssertEqual(coordinator.prepareCount, 0, + "the publisher must not perform the transition before subscription") + + let completed = expectation(description: "completed") + let cancellable = publisher.sink { _ in completed.fulfill() } + wait(for: [completed], timeout: 3) + XCTAssertEqual(coordinator.prepareCount, 1) + _ = cancellable + } +} diff --git a/Tests/XCoordinatorTests/ContextMenuInteractionTests.swift b/Tests/XCoordinatorTests/ContextMenuInteractionTests.swift new file mode 100644 index 00000000..b048dc27 --- /dev/null +++ b/Tests/XCoordinatorTests/ContextMenuInteractionTests.swift @@ -0,0 +1,68 @@ +// +// ContextMenuInteractionTests.swift +// XCoordinatorTests +// +// Created by Paul Kraft. +// Copyright © 2020 QuickBird Studios. All rights reserved. +// + +#if os(iOS) + +import UIKit +@testable import XCoordinator +import XCTest + +/// +/// Guards that the context-menu interaction performs its route through `performTransition` — so a coordinator +/// presented from a context menu is retained as a child rather than deallocated. +/// +/// The legacy implementation ran `transition.perform(...)` directly, bypassing child management. This is the +/// same hazard the deallocation-fix addresses (see `CoordinatorChildLifecycleTests`). +/// +@MainActor +final class ContextMenuInteractionTests: XCTestCase { + + // MARK: Stored properties + + lazy var window = makeWindow() + + // MARK: Tests + + func testCommittingPreviewRetainsPresentedCoordinatorAsChild() { + let coordinator = ContextMenuTestCoordinator() + coordinator.setRoot(for: window) + + let delegate = coordinator.contextMenuInteractionDelegate(for: .home) + guard let concreteDelegate = delegate as? CoordinatorContextMenuInteractionDelegate else { + return XCTFail("Unexpected delegate type: \(type(of: delegate))") + } + + XCTAssertTrue(coordinator.children.isEmpty, "Precondition: no children before committing the preview") + + concreteDelegate.performRoute() + + XCTAssertTrue( + coordinator.children.contains { $0.viewController === coordinator.child.viewController }, + "Coordinator presented from the context menu was not retained as a child" + ) + } + +} + +@MainActor +private final class ContextMenuTestCoordinator: ViewCoordinator { + + let child = BasicViewCoordinator(rootViewController: .init()) { _ in .present(UIViewController()) } + + init() { + super.init(rootViewController: .init()) + } + + // A synchronous transition so the test does not depend on on-screen presentation animations completing. + override func prepareTransition(for route: TestRoute) -> ViewTransition { + .synchronouslyPresent(child) + } + +} + +#endif diff --git a/Tests/XCoordinatorTests/CoordinatorChildLifecycleTests.swift b/Tests/XCoordinatorTests/CoordinatorChildLifecycleTests.swift new file mode 100644 index 00000000..eb2204d2 --- /dev/null +++ b/Tests/XCoordinatorTests/CoordinatorChildLifecycleTests.swift @@ -0,0 +1,132 @@ +// +// CoordinatorChildLifecycleTests.swift +// XCoordinatorTests +// +// Created by Paul Kraft. +// Copyright © 2018 QuickBird Studios. All rights reserved. +// + +import UIKit +import XCoordinator +import XCTest + +/// +/// Regression coverage for the "deallocation-fix" (`Add children at the end of transitions after clearing +/// other children`). +/// +/// `performTransition` used to register children *before* running the transition and call +/// `removeChildrenIfNeeded()` afterwards. Because a child coordinator's `rootViewController` is not yet in the +/// view hierarchy when a transition is kicked off — and `addChild` also wires the child's +/// `childTransitionCompleted()` back to the parent's `removeChildrenIfNeeded()` — any sweep firing during the +/// in-flight transition would judge the freshly-presented child "removable" and drop it from `children`, +/// deallocating the coordinator mid-presentation. +/// +/// The fix moved `addChild` into the completion, *after* `removeChildrenIfNeeded()` +/// (`Coordinators/Coordinator.swift`): a newly-presented child is therefore added *after* the transition's own +/// removal sweep and survives it, while a later sweep still reclaims a child once its view controller is gone. +/// +/// These tests drive `performTransition` with synchronous transitions so they validate that ordering +/// deterministically, without depending on on-screen presentation animations completing. +/// +@MainActor +final class CoordinatorChildLifecycleTests: XCTestCase { + + // MARK: Tests + + /// Core regression: a child added by a transition must survive that transition's own + /// `removeChildrenIfNeeded()` sweep, even before its view controller is in the hierarchy. + /// + /// Under the pre-fix ordering (`addChild` before `perform`, sweep in the completion) this child would be + /// swept away and deallocated; under the fix it is added *after* the sweep and survives. + func testPresentedChildSurvivesTransitionCompletionSweep() { + let parent = ViewCoordinator(rootViewController: .init()) + + weak var weakChild: BasicViewCoordinator? + let detachedViewController = UIViewController() // intentionally not in any view hierarchy + + autoreleasepool { + let child = makeChildCoordinator(rootViewController: detachedViewController) + weakChild = child + parent.performTransition(.synchronouslyPresent(child), with: .default) + } + + XCTAssertNotNil(weakChild, "Child added by the transition was swept/deallocated by the completion sweep") + XCTAssertTrue(parent.children.contains { $0.viewController === detachedViewController }, + "Child added by the transition was not tracked as a child") + } + + /// No-leak guard: once a child's view controller is gone, a subsequent sweep must reclaim it — i.e. the + /// fix did not trade the premature-deallocation bug for a retain leak. + func testChildReleasedOnceRemovedFromHierarchy() { + let parent = ViewCoordinator(rootViewController: .init()) + + weak var weakChild: BasicViewCoordinator? + + autoreleasepool { + let child = makeChildCoordinator(rootViewController: UIViewController()) + weakChild = child + parent.performTransition(.synchronouslyPresent(child), with: .default) + } + XCTAssertNotNil(weakChild, "Precondition: child should be retained after being added") + + // The child's view controller was never in the hierarchy, so the next sweep should reclaim it. + parent.removeChildrenIfNeeded() + + XCTAssertNil(weakChild, "Child leaked — removeChildrenIfNeeded did not reclaim a vanished child") + XCTAssertFalse(parent.children.contains { $0 is BasicViewCoordinator }, + "Reclaimed child is still tracked") + } + + /// A child whose view controller is in the hierarchy must be kept by a sweep, and only released once it + /// leaves the hierarchy. Exercises `canBeRemovedAsChild`'s hierarchy check end to end. + func testChildInHierarchyIsKeptUntilItLeaves() { + let parent = ViewCoordinator(rootViewController: .init()) + + weak var weakChild: BasicViewCoordinator? + let childViewController = UIViewController() + + // Embed the child's view controller so `childViewController.parent != nil` (i.e. it is in the hierarchy). + parent.rootViewController.addChild(childViewController) + parent.rootViewController.view.addSubview(childViewController.view) + childViewController.didMove(toParent: parent.rootViewController) + + autoreleasepool { + let child = makeChildCoordinator(rootViewController: childViewController) + weakChild = child + parent.performTransition(.synchronouslyPresent(child), with: .default) + } + + // A sweep must NOT remove the child while its view controller is in the hierarchy. + parent.removeChildrenIfNeeded() + XCTAssertNotNil(weakChild, "Child in the view hierarchy was incorrectly reclaimed") + XCTAssertTrue(parent.children.contains { $0.viewController === childViewController }, + "Child in the view hierarchy was dropped from its parent") + + // Once it leaves the hierarchy, the next sweep reclaims it. + childViewController.willMove(toParent: nil) + childViewController.view.removeFromSuperview() + childViewController.removeFromParent() + parent.removeChildrenIfNeeded() + + XCTAssertNil(weakChild, "Child leaked after leaving the view hierarchy") + } + + // MARK: Helpers + + private func makeChildCoordinator(rootViewController: UIViewController) -> BasicViewCoordinator { + BasicViewCoordinator(rootViewController: rootViewController) { _ in .none() } + } + +} + +extension Transition { + + /// A transition that "presents" a presentable but completes synchronously without any UIKit presentation, + /// so child bookkeeping in `performTransition` can be exercised without on-screen rendering. + static func synchronouslyPresent(_ presentable: any Presentable) -> Transition { + Transition(presentables: [presentable], animationInUse: nil) { _, _, completion in + completion?() + } + } + +} diff --git a/Tests/XCoordinatorTests/SwiftUIRoutingTests.swift b/Tests/XCoordinatorTests/SwiftUIRoutingTests.swift new file mode 100644 index 00000000..396f1a52 --- /dev/null +++ b/Tests/XCoordinatorTests/SwiftUIRoutingTests.swift @@ -0,0 +1,174 @@ +// +// SwiftUIRoutingTests.swift +// XCoordinatorTests +// +// Verifies that the SwiftUI routing context propagates so `@Routing` resolves. +// + +import SwiftUI +import UIKit +import XCoordinator +import XCTest + +/// A SwiftUI view that resolves `@Routing` from the environment and reports the result. +/// +/// Uses the projected value's subscript (rather than `wrappedValue`) so a missing router reports +/// `nil` instead of triggering the `fatalError` in `Routing.wrappedValue`. Reports both on appear and +/// whenever the injected routing context changes, so it catches routers that are merged in after the +/// first render. Callers latch on the first non-nil resolution. +private struct RouterProbeView: View { + + @Routing private var router + let onResolve: (AnyObject) -> Void + + var body: some View { + Color.clear + .onAppear { report() } + .onChange(of: $router) { _ in report() } + } + + private func report() { + if let resolved = $router[R.self] { + onResolve(resolved as AnyObject) + } + } +} + +@MainActor +final class SwiftUIRoutingTests: XCTestCase { + + lazy var window = makeWindow() + + /// `RoutingController` pushed from a UIKit coordinator must inject that coordinator so a + /// descendant `@Routing` resolves to it. (Regression for the snapshot-capture bug.) + func testRoutingControllerResolvesPushingCoordinator() { + let resolved = expectation(description: "resolved") + var resolvedRouter: AnyObject? + var didResolve = false + + let coordinator = BasicNavigationCoordinator( + rootViewController: .init() + ) { route in + switch route { + case .home: + Transition.push(RoutingController { + RouterProbeView { router in + guard !didResolve else { return } + didResolve = true + resolvedRouter = router + resolved.fulfill() + } + }) + } + } + coordinator.setRoot(for: window) + coordinator.trigger(.home) + + wait(for: [resolved], timeout: 5) + XCTAssertTrue(resolvedRouter === coordinator, + "@Routing should resolve to the pushing coordinator") + } + + /// `ViewCoordinator(body:)` hosts its SwiftUI content in a `RoutingController`; the coordinator + /// registers itself, so `@Routing` in the body resolves to it. + func testViewCoordinatorBodyResolvesItself() { + let resolved = expectation(description: "resolved") + var resolvedRouter: AnyObject? + var didResolve = false + + let coordinator = ViewCoordinator(body: { + RouterProbeView { router in + guard !didResolve else { return } + didResolve = true + resolvedRouter = router + resolved.fulfill() + } + }) + coordinator.setRoot(for: window) + + wait(for: [resolved], timeout: 5) + XCTAssertTrue(resolvedRouter === coordinator) + } + + /// A `WrappedRouter` publishes its router upward via the `PreferenceKey`; the hosting + /// `RoutingController` must merge it into its own context (the `onUpdate` path). + func testWrappedRouterPropagatesToHostContext() { + let embedded = ViewCoordinator(rootViewController: UIViewController()) + let host = RoutingController { + WrappedRouter { embedded } + } + window.rootViewController = host + window.makeKeyAndVisible() + + asyncWait(for: 0.5) + + let resolved = host.routingContext[TestRoute.self].map { $0 as AnyObject } + XCTAssertTrue(resolved === embedded, + "WrappedRouter should publish its router up to the hosting RoutingController's context") + } + + /// `WrappedRouter` builds its router exactly once and hosts it without crashing + /// (regression for mutating `@State` during a view update). + func testWrappedRouterBuildsRouterOnce() { + var createCount = 0 + let embedded = ViewCoordinator(rootViewController: UIViewController()) + + let host = UIHostingController( + rootView: WrappedRouter { () -> ViewCoordinator in + createCount += 1 + return embedded + } + ) + window.rootViewController = host + window.makeKeyAndVisible() + + asyncWait(for: 0.5) + XCTAssertEqual(createCount, 1, "WrappedRouter should build the router exactly once") + } + + // MARK: Retain-cycle regression + + /// `RoutingContext` must hold its routers **weakly**. A coordinator registers itself into the + /// context of a `RoutingController` it (transitively) owns, so a strong reference here would form a + /// retain cycle. Registering a router and then releasing its external owner must let it deallocate, + /// and the context must then resolve it to `nil`. + func testRoutingContextHoldsRoutersWeakly() { + var context = RoutingContext() + weak var weakRouter: ViewCoordinator? + + autoreleasepool { + let router = ViewCoordinator(rootViewController: UIViewController()) + weakRouter = router + context.add(router) + XCTAssertTrue(context[TestRoute.self] === router, "Router should resolve while it is alive") + } + + XCTAssertNil(weakRouter, "RoutingContext retained its router strongly — retain cycle") + XCTAssertNil(context[TestRoute.self], "A deallocated router must resolve to nil") + } + + /// End-to-end proof that the routing context no longer forms a retain cycle. This reproduces the + /// exact cycle shape — `coordinator → children → RoutingController → box → context → coordinator` — + /// and asserts the whole graph is reclaimed once the external references are dropped. Before the + /// weak-storage fix, the `context → coordinator` strong edge kept both objects alive forever. + func testCoordinatorAndRoutingControllerDeallocateWithoutCycle() { + weak var weakCoordinator: ViewCoordinator? + weak var weakController: UIViewController? + + autoreleasepool { + let coordinator = ViewCoordinator(rootViewController: UIViewController()) + let controller = RoutingController { RouterProbeView { _ in } } + + // context → coordinator (the edge that used to be strong) + controller.routingContext.add(coordinator) + // coordinator → children → controller + coordinator.addChild(controller) + + weakCoordinator = coordinator + weakController = controller + } + + XCTAssertNil(weakCoordinator, "Coordinator leaked — RoutingContext retained it strongly") + XCTAssertNil(weakController, "RoutingController leaked as part of the coordinator/context cycle") + } +} diff --git a/Tests/XCoordinatorTests/TabSplitBindingTests.swift b/Tests/XCoordinatorTests/TabSplitBindingTests.swift new file mode 100644 index 00000000..f81e75ca --- /dev/null +++ b/Tests/XCoordinatorTests/TabSplitBindingTests.swift @@ -0,0 +1,68 @@ +// +// TabSplitBindingTests.swift +// XCoordinatorTests +// +// Regression tests for the TabBarCoordinator binding initializers and SplitCoordinator columns. +// + +import SwiftUI +import UIKit +import XCoordinator +import XCTest + +@MainActor +final class TabSplitBindingTests: XCTestCase { + + lazy var window = makeWindow() + + /// An empty `items` collection must not crash the binding initializer. + func testTabBarEmptyItemsDoesNotCrash() { + var selection = -1 + let binding = Binding(get: { selection }, set: { selection = $0 }) + let coordinator = TabBarCoordinator(items: [Int](), selection: binding) { _ in + UIViewController() + } + coordinator.setRoot(for: window) + asyncWait(for: 0.1) + XCTAssertEqual(coordinator.rootViewController.viewControllers?.count ?? 0, 0) + } + + /// A non-zero-based collection (e.g. an `ArraySlice`) must select the correct tab and not crash, + /// because the tab bar's 0-based index space differs from the collection's index space. + func testTabBarNonZeroBasedSliceSelectsCorrectTab() { + let slice = [10, 20, 30][1...] // [20, 30], startIndex == 1 + var selection = 30 + let binding = Binding(get: { selection }, set: { selection = $0 }) + let coordinator = TabBarCoordinator(items: slice, selection: binding) { value in + let viewController = UIViewController() + viewController.title = "\(value)" + return viewController + } + coordinator.setRoot(for: window) + asyncWait(for: 0.2) + + XCTAssertEqual(coordinator.rootViewController.viewControllers?.count, 2) + XCTAssertEqual(selection, 30, "the caller's selection must not be clobbered to a wrong value") + XCTAssertEqual(coordinator.rootViewController.selectedViewController?.title, "30") + } + + /// The supplementary column must be populated on a triple-column split controller. + func testSplitSupplementaryColumnIsPopulated() { + let split = UISplitViewController(style: .tripleColumn) + let primary = UIViewController() + let secondary = UIViewController() + let supplementary = UIViewController() + let coordinator = SplitCoordinator( + rootViewController: split, + primary: primary, + secondary: secondary, + supplementary: supplementary + ) + coordinator.setRoot(for: window) + asyncWait(for: 0.3) + + XCTAssertTrue(split.viewController(for: .primary) === primary) + XCTAssertTrue(split.viewController(for: .secondary) === secondary) + XCTAssertTrue(split.viewController(for: .supplementary) === supplementary) + } +} diff --git a/Tests/XCoordinatorTests/TestAnimation.swift b/Tests/XCoordinatorTests/TestAnimation.swift index 4dd6e1f0..d224c8a3 100644 --- a/Tests/XCoordinatorTests/TestAnimation.swift +++ b/Tests/XCoordinatorTests/TestAnimation.swift @@ -26,16 +26,24 @@ class TestAnimation: Animation { } private static func interactiveTransitionAnimation(for expectation: XCTestExpectation?) -> TransitionAnimation { - InteractiveTransitionAnimation(duration: 0.1) { + InteractiveTransitionAnimation(duration: 0.1) { context in expectation?.fulfill() - $0.completeTransition(true) + // Complete asynchronously, like a real animator does after its duration. + // Completing synchronously finishes the transition before UIKit's + // transitionCoordinator-based completion can register, which drops the + // completion handler (notably for navigation push/pop and tab selection). + DispatchQueue.main.async { + context.completeTransition(true) + } } } private static func staticTransitionAnimation(for expectation: XCTestExpectation?) -> TransitionAnimation { - StaticTransitionAnimation(duration: 0.1) { + StaticTransitionAnimation(duration: 0.1) { context in expectation?.fulfill() - $0.completeTransition(true) + DispatchQueue.main.async { + context.completeTransition(true) + } } } diff --git a/Tests/XCoordinatorTests/TransitionBuilderTests.swift b/Tests/XCoordinatorTests/TransitionBuilderTests.swift new file mode 100644 index 00000000..824de3e9 --- /dev/null +++ b/Tests/XCoordinatorTests/TransitionBuilderTests.swift @@ -0,0 +1,59 @@ +// +// TransitionBuilderTests.swift +// XCoordinatorTests +// +// Verifies the @TransitionBuilder result builder composes transitions as documented. +// + +import UIKit +import XCoordinator +import XCTest + +@MainActor +final class TransitionBuilderTests: XCTestCase { + + @TransitionBuilder + private func twoStatements(_ first: UIViewController, _ second: UIViewController) -> ViewTransition { + Transition.present(first) + Transition.present(second) + } + + @TransitionBuilder + private func conditional(_ include: Bool, _ viewController: UIViewController) -> ViewTransition { + if include { + Transition.present(viewController) + } else { + Transition.none() + } + } + + @TransitionBuilder + private func single(_ viewController: UIViewController) -> ViewTransition { + Transition.present(viewController) + } + + /// Listing several statements chains them like `.multiple`, preserving order. + func testBuilderChainsStatementsInOrder() { + let first = UIViewController() + let second = UIViewController() + let transition = twoStatements(first, second) + XCTAssertEqual(transition.presentables.count, 2) + XCTAssertTrue(transition.presentables[0].viewController === first) + XCTAssertTrue(transition.presentables[1].viewController === second) + } + + /// `if`/`else` (buildEither) selects the right branch. + func testBuilderConditionalBranches() { + let viewController = UIViewController() + XCTAssertEqual(conditional(true, viewController).presentables.count, 1) + XCTAssertEqual(conditional(false, viewController).presentables.count, 0) + } + + /// A single statement passes through unchanged. + func testBuilderSingleStatementPassthrough() { + let viewController = UIViewController() + let transition = single(viewController) + XCTAssertEqual(transition.presentables.count, 1) + XCTAssertTrue(transition.presentables[0].viewController === viewController) + } +} diff --git a/Tests/XCoordinatorTests/TransitionSwiftUITests.swift b/Tests/XCoordinatorTests/TransitionSwiftUITests.swift new file mode 100644 index 00000000..83cca96b --- /dev/null +++ b/Tests/XCoordinatorTests/TransitionSwiftUITests.swift @@ -0,0 +1,53 @@ +// +// TransitionSwiftUITests.swift +// XCoordinatorTests +// +// Verifies Transition.withAnimation / withTransaction run their body and call completion. +// + +import SwiftUI +import UIKit +import XCoordinator +import XCTest + +@MainActor +final class TransitionSwiftUITests: XCTestCase { + + func testWithAnimationRunsBodyAndCompletes() { + var bodyRan = false + let completed = expectation(description: "completion") + let transition = Transition.withAnimation { bodyRan = true } + transition.perform(on: UIViewController(), with: .init(animated: true)) { + completed.fulfill() + } + wait(for: [completed], timeout: 3) + XCTAssertTrue(bodyRan) + } + + func testWithAnimationCompletesWhenNotAnimated() { + var bodyRan = false + let completed = expectation(description: "completion") + let transition = Transition.withAnimation { bodyRan = true } + transition.perform(on: UIViewController(), with: .init(animated: false)) { + completed.fulfill() + } + wait(for: [completed], timeout: 3) + XCTAssertTrue(bodyRan) + } + + func testWithTransactionRunsBodyAndCompletes() { + var bodyRan = false + let completed = expectation(description: "completion") + let transition = Transition.withTransaction(Transaction()) { bodyRan = true } + transition.perform(on: UIViewController(), with: .init(animated: true)) { + completed.fulfill() + } + wait(for: [completed], timeout: 3) + XCTAssertTrue(bodyRan) + } + + func testWithAnimationHasNoPresentables() { + let transition = Transition.withAnimation { } + XCTAssertTrue(transition.presentables.isEmpty) + } +} diff --git a/Tests/XCoordinatorTests/TransitionTests.swift b/Tests/XCoordinatorTests/TransitionTests.swift index c60e6498..c67014d8 100644 --- a/Tests/XCoordinatorTests/TransitionTests.swift +++ b/Tests/XCoordinatorTests/TransitionTests.swift @@ -10,21 +10,12 @@ import UIKit import XCoordinator import XCTest +@MainActor class TransitionTests: XCTestCase { - // MARK: Static properties - - static let allTests = [ - ("testPageCoordinator", testPageCoordinator), - ("testSplitCoordinator", testSplitCoordinator), - ("testTabBarCoordinator", testTabBarCoordinator), - ("testViewCoordinator", testViewCoordinator), - ("testNavigationCoordinator", testNavigationCoordinator), - ] - // MARK: Stored properties - lazy var window = UIWindow() + lazy var window = makeWindow() // MARK: Tests @@ -39,7 +30,7 @@ class TransitionTests: XCTestCase { } func testSplitCoordinator() { - let coordinator = SplitCoordinator(master: UIViewController(), detail: UIViewController()) + let coordinator = SplitCoordinator(primary: UIViewController(), secondary: UIViewController()) coordinator.setRoot(for: window) testStandardTransitions(on: coordinator) testCompletionCalled( @@ -78,24 +69,32 @@ class TransitionTests: XCTestCase { testCompletionCalled(on: coordinator, transition: .pop(to: viewControllers[0])) } + // MARK: Regression coverage + + /// `Transition.set(_:animation:)` on a `UITabBarController` must expose its presentation animation + /// via `transition.animation` (used by `registerInteractiveTransition`). Regression guard: a previous + /// refactor dropped it (`animationInUse: nil`). + func testSetTabsExposesAnimation() { + let animation = Animation( + presentation: StaticTransitionAnimation(duration: 0) { $0.completeTransition(true) }, + dismissal: StaticTransitionAnimation(duration: 0) { $0.completeTransition(true) } + ) + let transition: TabBarTransition = .set([UIViewController()], animation: animation) + XCTAssertNotNil(transition.animation) + } + // MARK: Helpers - private func testStandardTransitions(on coordinator: C) where C.TransitionType == Transition { - print("none") + private func testStandardTransitions(on coordinator: C) { testCompletionCalled(on: coordinator, transition: .none()) - print("present") testCompletionCalled(on: coordinator, transition: .present(UIViewController())) - print("dismiss") testCompletionCalled(on: coordinator, transition: .dismiss()) - print("embed") testCompletionCalled(on: coordinator, transition: .embed(UIViewController(), in: UIViewController())) - print("multiple(none)") testCompletionCalled(on: coordinator, transition: .multiple(.none())) - print("multiple(empty)") testCompletionCalled(on: coordinator, transition: .multiple()) } - private func testCompletionCalled(on coordinator: C, transition: C.TransitionType) { + private func testCompletionCalled(on coordinator: C, transition: Transition) { let exp = expectation(description: "\(Date().timeIntervalSince1970)") DispatchQueue.main.async { coordinator.performTransition(transition, with: .init(animated: true)) { diff --git a/Tests/XCoordinatorTests/TriggerModifierTests.swift b/Tests/XCoordinatorTests/TriggerModifierTests.swift new file mode 100644 index 00000000..795f9db7 --- /dev/null +++ b/Tests/XCoordinatorTests/TriggerModifierTests.swift @@ -0,0 +1,116 @@ +// +// TriggerModifierTests.swift +// XCoordinatorTests +// +// Verifies the declarative trigger view modifiers fire (and skip the initial value) as documented. +// + +import SwiftUI +import UIKit +import XCoordinator +import XCTest + +/// A coordinator that records the routes triggered on it (returning a no-op transition). +@MainActor +private final class RecordingCoordinator: ViewCoordinator { + + private(set) var triggered: [TestRoute] = [] + var onTrigger: (() -> Void)? + + init() { + super.init(rootViewController: UIViewController()) + } + + override func prepareTransition(for route: TestRoute) -> ViewTransition { + triggered.append(route) + onTrigger?() + return .none() + } +} + +@MainActor +private final class Model: ObservableObject { + @Published var value = 0 +} + +@MainActor +final class TriggerModifierTests: XCTestCase { + + lazy var window = makeWindow() + + private func host(_ view: Content) { + window.rootViewController = UIHostingController(rootView: view) + window.makeKeyAndVisible() + } + + /// `triggerOnAppear` must fire exactly once when the view appears. (Regression for the inverted guard.) + func testTriggerOnAppearFiresOnce() { + let coordinator = RecordingCoordinator() + // No `assertForOverFulfill = false`: triggerOnAppear must fire exactly once, so a second + // fulfillment should fail the test (it would mean the route fired more than once). + let fired = expectation(description: "fired") + coordinator.onTrigger = { fired.fulfill() } + + host( + Color.clear + .triggerOnAppear(route: TestRoute.home) + .router(coordinator) + ) + + wait(for: [fired], timeout: 5) + asyncWait(for: 0.2) + XCTAssertEqual(coordinator.triggered, [.home]) + } + + /// `triggerOnChange(of:)` must skip the initial value and fire when the value changes. + func testTriggerOnChangeSkipsInitialThenFires() { + let coordinator = RecordingCoordinator() + let model = Model() + + struct Probe: View { + @ObservedObject var model: Model + let coordinator: RecordingCoordinator + var body: some View { + Color.clear + .triggerOnChange(of: model.value, route: TestRoute.home) + .router(coordinator) + } + } + + host(Probe(model: model, coordinator: coordinator)) + asyncWait(for: 0.3) + XCTAssertEqual(coordinator.triggered, [], "triggerOnChange must skip the initial value") + + let fired = expectation(description: "fired") + coordinator.onTrigger = { fired.fulfill() } + model.value = 1 + wait(for: [fired], timeout: 5) + XCTAssertEqual(coordinator.triggered, [.home]) + } + + /// `trigger(when:)` must fire only when the condition transitions to `true`. + func testTriggerWhenFiresOnFalseToTrue() { + let coordinator = RecordingCoordinator() + let model = Model() // value 0 => condition false + + struct Probe: View { + @ObservedObject var model: Model + let coordinator: RecordingCoordinator + var body: some View { + Color.clear + .trigger(when: model.value == 1, route: TestRoute.home) + .router(coordinator) + } + } + + host(Probe(model: model, coordinator: coordinator)) + asyncWait(for: 0.3) + XCTAssertEqual(coordinator.triggered, [], "should not fire while the condition is false") + + let fired = expectation(description: "fired") + coordinator.onTrigger = { fired.fulfill() } + model.value = 1 + wait(for: [fired], timeout: 5) + XCTAssertEqual(coordinator.triggered, [.home]) + } +} diff --git a/Tests/XCoordinatorTests/XCTest+Extras.swift b/Tests/XCoordinatorTests/XCTest+Extras.swift new file mode 100644 index 00000000..47fd6761 --- /dev/null +++ b/Tests/XCoordinatorTests/XCTest+Extras.swift @@ -0,0 +1,39 @@ +// +// XCText+Extras.swift +// XCoordinator_Tests +// +// Created by Paul Kraft on 20.11.18. +// Copyright © 2018 QuickBird Studios. All rights reserved. +// + +import Foundation +import UIKit +import XCTest + +extension XCTestCase { + + /// Creates a window attached to the host app's foreground `UIWindowScene`. + /// + /// UIKit only renders windows that belong to an active scene, and navigation + /// push/pop animations only run (and call their completion) when the controller + /// is actually on screen. A bare `UIWindow()` has no scene and never renders, + /// so the tests use the scene provided by the test-host application. + @MainActor + func makeWindow() -> UIWindow { + let windowScenes = UIApplication.shared.connectedScenes.compactMap { $0 as? UIWindowScene } + let scene = windowScenes.first { $0.activationState == .foregroundActive } ?? windowScenes.first + if let scene { + return UIWindow(windowScene: scene) + } + return UIWindow(frame: UIScreen.main.bounds) + } + + func asyncWait(for timeInterval: TimeInterval) { + let waitExpectation = self.expectation(description: "WAIT \(Date().timeIntervalSince1970)") + DispatchQueue.global(qos: .userInitiated).asyncAfter(deadline: .now() + timeInterval) { + waitExpectation.fulfill() + } + wait(for: [waitExpectation], timeout: max(timeInterval * 2, 1)) + } + +} diff --git a/Tests/XCoordinatorTests/XCTestManifests.swift b/Tests/XCoordinatorTests/XCTestManifests.swift deleted file mode 100644 index 66c74c72..00000000 --- a/Tests/XCoordinatorTests/XCTestManifests.swift +++ /dev/null @@ -1,10 +0,0 @@ -import XCTest - -#if !canImport(ObjectiveC) -public func allTests() -> [XCTestCaseEntry] { - [ - testCase(AnimationTests.allTests), - testCase(TransitionTests.allTests) - ] -} -#endif diff --git a/Tests/XCoordinatorTests/XCText+Extras.swift b/Tests/XCoordinatorTests/XCText+Extras.swift deleted file mode 100644 index ddab2fa3..00000000 --- a/Tests/XCoordinatorTests/XCText+Extras.swift +++ /dev/null @@ -1,22 +0,0 @@ -// -// XCText+Extras.swift -// XCoordinator_Tests -// -// Created by Paul Kraft on 20.11.18. -// Copyright © 2018 QuickBird Studios. All rights reserved. -// - -import Foundation -import XCTest - -extension XCTestCase { - - func asyncWait(for timeInterval: TimeInterval) { - let waitExpectation = self.expectation(description: "WAIT \(Date().timeIntervalSince1970)") - DispatchQueue.global(qos: .userInitiated).asyncAfter(deadline: .now() + timeInterval) { - waitExpectation.fulfill() - } - wait(for: [waitExpectation], timeout: max(timeInterval * 2, 1)) - } - -} diff --git a/Tests/XCoordinatorTests/XCoordinatorTests.xctestplan b/Tests/XCoordinatorTests/XCoordinatorTests.xctestplan deleted file mode 100644 index b8125f08..00000000 --- a/Tests/XCoordinatorTests/XCoordinatorTests.xctestplan +++ /dev/null @@ -1,24 +0,0 @@ -{ - "configurations" : [ - { - "id" : "15E74A77-4992-49D7-9071-88779978ED68", - "name" : "Configuration 1", - "options" : { - - } - } - ], - "defaultOptions" : { - - }, - "testTargets" : [ - { - "target" : { - "containerPath" : "container:XCoordinator.xcodeproj", - "identifier" : "XCoordinator::XCoordinatorTests", - "name" : "XCoordinatorTests" - } - } - ], - "version" : 1 -} diff --git a/XCoordinator.podspec b/XCoordinator.podspec index 656ea39d..73ed2409 100644 --- a/XCoordinator.podspec +++ b/XCoordinator.podspec @@ -1,31 +1,26 @@ Pod::Spec.new do |spec| spec.name = 'XCoordinator' - spec.version = '2.2.1' + spec.version = '3.0.0' spec.license = { :type => 'MIT' } spec.homepage = 'https://github.com/quickbirdstudios/XCoordinator' spec.authors = { 'Stefan Kofler' => 'stefan.kofler@quickbirdstudios.com', 'Paul Kraft' => 'pauljohannes.kraft@quickbirdstudios.com' } spec.summary = 'Navigation framework based on coordinator pattern.' spec.source = { :git => 'https://github.com/quickbirdstudios/XCoordinator.git', :tag => spec.version } spec.module_name = 'XCoordinator' - spec.swift_version = '5.1' - spec.ios.deployment_target = '9.0' - spec.tvos.deployment_target = '9.0' - spec.source_files = 'Sources/XCoordinator/*.swift' + spec.swift_version = '5.9' + spec.ios.deployment_target = '16.0' + spec.tvos.deployment_target = '16.0' + spec.source_files = 'Sources/XCoordinator/**/*.swift' spec.default_subspec = 'Core' spec.subspec 'Core' do |ss| - ss.source_files = 'Sources/XCoordinator/*.swift' + ss.source_files = 'Sources/XCoordinator/**/*.swift' ss.framework = 'UIKit' end spec.subspec 'RxSwift' do |ss| ss.dependency 'XCoordinator/Core' - ss.dependency 'RxSwift', '~> 6.1' - ss.source_files = 'Sources/XCoordinatorRx/*.swift' - end - - spec.subspec 'Combine' do |ss| - ss.dependency 'XCoordinator/Core' - ss.source_files = 'Sources/XCoordinatorCombine/*.swift' + ss.dependency 'RxSwift', '~> 6.5' + ss.source_files = 'Sources/XCoordinatorRx/**/*.swift' end end diff --git a/XCoordinator.xcodeproj/RxSwift_Info.plist b/XCoordinator.xcodeproj/RxSwift_Info.plist deleted file mode 100644 index 57ada9f9..00000000 --- a/XCoordinator.xcodeproj/RxSwift_Info.plist +++ /dev/null @@ -1,25 +0,0 @@ - - - - CFBundleDevelopmentRegion - en - CFBundleExecutable - $(EXECUTABLE_NAME) - CFBundleIdentifier - $(PRODUCT_BUNDLE_IDENTIFIER) - CFBundleInfoDictionaryVersion - 6.0 - CFBundleName - $(PRODUCT_NAME) - CFBundlePackageType - FMWK - CFBundleShortVersionString - 1.0 - CFBundleSignature - ???? - CFBundleVersion - $(CURRENT_PROJECT_VERSION) - NSPrincipalClass - - - diff --git a/XCoordinator.xcodeproj/XCoordinatorCombine_Info.plist b/XCoordinator.xcodeproj/XCoordinatorCombine_Info.plist deleted file mode 100644 index 57ada9f9..00000000 --- a/XCoordinator.xcodeproj/XCoordinatorCombine_Info.plist +++ /dev/null @@ -1,25 +0,0 @@ - - - - CFBundleDevelopmentRegion - en - CFBundleExecutable - $(EXECUTABLE_NAME) - CFBundleIdentifier - $(PRODUCT_BUNDLE_IDENTIFIER) - CFBundleInfoDictionaryVersion - 6.0 - CFBundleName - $(PRODUCT_NAME) - CFBundlePackageType - FMWK - CFBundleShortVersionString - 1.0 - CFBundleSignature - ???? - CFBundleVersion - $(CURRENT_PROJECT_VERSION) - NSPrincipalClass - - - diff --git a/XCoordinator.xcodeproj/XCoordinatorRx_Info.plist b/XCoordinator.xcodeproj/XCoordinatorRx_Info.plist deleted file mode 100644 index 57ada9f9..00000000 --- a/XCoordinator.xcodeproj/XCoordinatorRx_Info.plist +++ /dev/null @@ -1,25 +0,0 @@ - - - - CFBundleDevelopmentRegion - en - CFBundleExecutable - $(EXECUTABLE_NAME) - CFBundleIdentifier - $(PRODUCT_BUNDLE_IDENTIFIER) - CFBundleInfoDictionaryVersion - 6.0 - CFBundleName - $(PRODUCT_NAME) - CFBundlePackageType - FMWK - CFBundleShortVersionString - 1.0 - CFBundleSignature - ???? - CFBundleVersion - $(CURRENT_PROJECT_VERSION) - NSPrincipalClass - - - diff --git a/XCoordinator.xcodeproj/XCoordinatorTests_Info.plist b/XCoordinator.xcodeproj/XCoordinatorTests_Info.plist deleted file mode 100644 index 7c23420d..00000000 --- a/XCoordinator.xcodeproj/XCoordinatorTests_Info.plist +++ /dev/null @@ -1,25 +0,0 @@ - - - - CFBundleDevelopmentRegion - en - CFBundleExecutable - $(EXECUTABLE_NAME) - CFBundleIdentifier - $(PRODUCT_BUNDLE_IDENTIFIER) - CFBundleInfoDictionaryVersion - 6.0 - CFBundleName - $(PRODUCT_NAME) - CFBundlePackageType - BNDL - CFBundleShortVersionString - 1.0 - CFBundleSignature - ???? - CFBundleVersion - $(CURRENT_PROJECT_VERSION) - NSPrincipalClass - - - diff --git a/XCoordinator.xcodeproj/XCoordinator_Info.plist b/XCoordinator.xcodeproj/XCoordinator_Info.plist deleted file mode 100644 index 57ada9f9..00000000 --- a/XCoordinator.xcodeproj/XCoordinator_Info.plist +++ /dev/null @@ -1,25 +0,0 @@ - - - - CFBundleDevelopmentRegion - en - CFBundleExecutable - $(EXECUTABLE_NAME) - CFBundleIdentifier - $(PRODUCT_BUNDLE_IDENTIFIER) - CFBundleInfoDictionaryVersion - 6.0 - CFBundleName - $(PRODUCT_NAME) - CFBundlePackageType - FMWK - CFBundleShortVersionString - 1.0 - CFBundleSignature - ???? - CFBundleVersion - $(CURRENT_PROJECT_VERSION) - NSPrincipalClass - - - diff --git a/XCoordinator.xcodeproj/project.pbxproj b/XCoordinator.xcodeproj/project.pbxproj deleted file mode 100644 index e4d1cf51..00000000 --- a/XCoordinator.xcodeproj/project.pbxproj +++ /dev/null @@ -1,3470 +0,0 @@ -// !$*UTF8*$! -{ - archiveVersion = "1"; - objectVersion = "46"; - objects = { - "OBJ_1" = { - isa = "PBXProject"; - attributes = { - LastSwiftMigration = "9999"; - LastUpgradeCheck = "9999"; - }; - buildConfigurationList = "OBJ_2"; - compatibilityVersion = "Xcode 3.2"; - developmentRegion = "en"; - hasScannedForEncodings = "0"; - knownRegions = ( - "en" - ); - mainGroup = "OBJ_5"; - productRefGroup = "OBJ_233"; - projectDirPath = "."; - targets = ( - "RxSwift::RxSwift", - "RxSwift::SwiftPMPackageDescription", - "XCoordinator::XCoordinator", - "XCoordinator::XCoordinatorCombine", - "XCoordinator::SwiftPMPackageDescription", - "XCoordinator::XCoordinatorPackageTests::ProductTarget", - "XCoordinator::XCoordinatorRx", - "XCoordinator::XCoordinatorTests" - ); - }; - "OBJ_10" = { - isa = "PBXFileReference"; - path = "AnyCoordinator.swift"; - sourceTree = ""; - }; - "OBJ_100" = { - isa = "PBXFileReference"; - path = "Concat.swift"; - sourceTree = ""; - }; - "OBJ_101" = { - isa = "PBXFileReference"; - path = "ConcurrentDispatchQueueScheduler.swift"; - sourceTree = ""; - }; - "OBJ_102" = { - isa = "PBXFileReference"; - path = "ConcurrentMainScheduler.swift"; - sourceTree = ""; - }; - "OBJ_103" = { - isa = "PBXFileReference"; - path = "ConnectableObservableType.swift"; - sourceTree = ""; - }; - "OBJ_104" = { - isa = "PBXFileReference"; - path = "Create.swift"; - sourceTree = ""; - }; - "OBJ_105" = { - isa = "PBXFileReference"; - path = "CurrentThreadScheduler.swift"; - sourceTree = ""; - }; - "OBJ_106" = { - isa = "PBXFileReference"; - path = "Date+Dispatch.swift"; - sourceTree = ""; - }; - "OBJ_107" = { - isa = "PBXFileReference"; - path = "Debounce.swift"; - sourceTree = ""; - }; - "OBJ_108" = { - isa = "PBXFileReference"; - path = "Debug.swift"; - sourceTree = ""; - }; - "OBJ_109" = { - isa = "PBXFileReference"; - path = "Decode.swift"; - sourceTree = ""; - }; - "OBJ_11" = { - isa = "PBXFileReference"; - path = "AnyTransitionPerformer.swift"; - sourceTree = ""; - }; - "OBJ_110" = { - isa = "PBXFileReference"; - path = "DefaultIfEmpty.swift"; - sourceTree = ""; - }; - "OBJ_111" = { - isa = "PBXFileReference"; - path = "Deferred.swift"; - sourceTree = ""; - }; - "OBJ_112" = { - isa = "PBXFileReference"; - path = "Delay.swift"; - sourceTree = ""; - }; - "OBJ_113" = { - isa = "PBXFileReference"; - path = "DelaySubscription.swift"; - sourceTree = ""; - }; - "OBJ_114" = { - isa = "PBXFileReference"; - path = "Dematerialize.swift"; - sourceTree = ""; - }; - "OBJ_115" = { - isa = "PBXFileReference"; - path = "DispatchQueue+Extensions.swift"; - sourceTree = ""; - }; - "OBJ_116" = { - isa = "PBXFileReference"; - path = "DispatchQueueConfiguration.swift"; - sourceTree = ""; - }; - "OBJ_117" = { - isa = "PBXFileReference"; - path = "Disposable.swift"; - sourceTree = ""; - }; - "OBJ_118" = { - isa = "PBXFileReference"; - path = "Disposables.swift"; - sourceTree = ""; - }; - "OBJ_119" = { - isa = "PBXFileReference"; - path = "DisposeBag.swift"; - sourceTree = ""; - }; - "OBJ_12" = { - isa = "PBXFileReference"; - path = "BaseCoordinator.swift"; - sourceTree = ""; - }; - "OBJ_120" = { - isa = "PBXFileReference"; - path = "DisposeBase.swift"; - sourceTree = ""; - }; - "OBJ_121" = { - isa = "PBXFileReference"; - path = "DistinctUntilChanged.swift"; - sourceTree = ""; - }; - "OBJ_122" = { - isa = "PBXFileReference"; - path = "Do.swift"; - sourceTree = ""; - }; - "OBJ_123" = { - isa = "PBXFileReference"; - path = "ElementAt.swift"; - sourceTree = ""; - }; - "OBJ_124" = { - isa = "PBXFileReference"; - path = "Empty.swift"; - sourceTree = ""; - }; - "OBJ_125" = { - isa = "PBXFileReference"; - path = "Enumerated.swift"; - sourceTree = ""; - }; - "OBJ_126" = { - isa = "PBXFileReference"; - path = "Error.swift"; - sourceTree = ""; - }; - "OBJ_127" = { - isa = "PBXFileReference"; - path = "Errors.swift"; - sourceTree = ""; - }; - "OBJ_128" = { - isa = "PBXFileReference"; - path = "Event.swift"; - sourceTree = ""; - }; - "OBJ_129" = { - isa = "PBXFileReference"; - path = "Filter.swift"; - sourceTree = ""; - }; - "OBJ_13" = { - isa = "PBXFileReference"; - path = "BasicCoordinator.swift"; - sourceTree = ""; - }; - "OBJ_130" = { - isa = "PBXFileReference"; - path = "First.swift"; - sourceTree = ""; - }; - "OBJ_131" = { - isa = "PBXFileReference"; - path = "Generate.swift"; - sourceTree = ""; - }; - "OBJ_132" = { - isa = "PBXFileReference"; - path = "GroupBy.swift"; - sourceTree = ""; - }; - "OBJ_133" = { - isa = "PBXFileReference"; - path = "GroupedObservable.swift"; - sourceTree = ""; - }; - "OBJ_134" = { - isa = "PBXFileReference"; - path = "HistoricalScheduler.swift"; - sourceTree = ""; - }; - "OBJ_135" = { - isa = "PBXFileReference"; - path = "HistoricalSchedulerTimeConverter.swift"; - sourceTree = ""; - }; - "OBJ_136" = { - isa = "PBXFileReference"; - path = "ImmediateSchedulerType.swift"; - sourceTree = ""; - }; - "OBJ_137" = { - isa = "PBXFileReference"; - path = "Infallible+CombineLatest+arity.swift"; - sourceTree = ""; - }; - "OBJ_138" = { - isa = "PBXFileReference"; - path = "Infallible+Create.swift"; - sourceTree = ""; - }; - "OBJ_139" = { - isa = "PBXFileReference"; - path = "Infallible+Operators.swift"; - sourceTree = ""; - }; - "OBJ_14" = { - isa = "PBXFileReference"; - path = "Container.swift"; - sourceTree = ""; - }; - "OBJ_140" = { - isa = "PBXFileReference"; - path = "Infallible+Zip+arity.swift"; - sourceTree = ""; - }; - "OBJ_141" = { - isa = "PBXFileReference"; - path = "Infallible.swift"; - sourceTree = ""; - }; - "OBJ_142" = { - isa = "PBXFileReference"; - path = "InfiniteSequence.swift"; - sourceTree = ""; - }; - "OBJ_143" = { - isa = "PBXFileReference"; - path = "InvocableScheduledItem.swift"; - sourceTree = ""; - }; - "OBJ_144" = { - isa = "PBXFileReference"; - path = "InvocableType.swift"; - sourceTree = ""; - }; - "OBJ_145" = { - isa = "PBXFileReference"; - path = "Just.swift"; - sourceTree = ""; - }; - "OBJ_146" = { - isa = "PBXFileReference"; - path = "Lock.swift"; - sourceTree = ""; - }; - "OBJ_147" = { - isa = "PBXFileReference"; - path = "LockOwnerType.swift"; - sourceTree = ""; - }; - "OBJ_148" = { - isa = "PBXFileReference"; - path = "MainScheduler.swift"; - sourceTree = ""; - }; - "OBJ_149" = { - isa = "PBXFileReference"; - path = "Map.swift"; - sourceTree = ""; - }; - "OBJ_15" = { - isa = "PBXFileReference"; - path = "Coordinator.swift"; - sourceTree = ""; - }; - "OBJ_150" = { - isa = "PBXFileReference"; - path = "Materialize.swift"; - sourceTree = ""; - }; - "OBJ_151" = { - isa = "PBXFileReference"; - path = "Maybe.swift"; - sourceTree = ""; - }; - "OBJ_152" = { - isa = "PBXFileReference"; - path = "Merge.swift"; - sourceTree = ""; - }; - "OBJ_153" = { - isa = "PBXFileReference"; - path = "Multicast.swift"; - sourceTree = ""; - }; - "OBJ_154" = { - isa = "PBXFileReference"; - path = "Never.swift"; - sourceTree = ""; - }; - "OBJ_155" = { - isa = "PBXFileReference"; - path = "NopDisposable.swift"; - sourceTree = ""; - }; - "OBJ_156" = { - isa = "PBXFileReference"; - path = "Observable.swift"; - sourceTree = ""; - }; - "OBJ_157" = { - isa = "PBXFileReference"; - path = "ObservableConvertibleType+Infallible.swift"; - sourceTree = ""; - }; - "OBJ_158" = { - isa = "PBXFileReference"; - path = "ObservableConvertibleType.swift"; - sourceTree = ""; - }; - "OBJ_159" = { - isa = "PBXFileReference"; - path = "ObservableType+Extensions.swift"; - sourceTree = ""; - }; - "OBJ_16" = { - isa = "PBXFileReference"; - path = "CoordinatorPreviewingDelegateObject.swift"; - sourceTree = ""; - }; - "OBJ_160" = { - isa = "PBXFileReference"; - path = "ObservableType+PrimitiveSequence.swift"; - sourceTree = ""; - }; - "OBJ_161" = { - isa = "PBXFileReference"; - path = "ObservableType.swift"; - sourceTree = ""; - }; - "OBJ_162" = { - isa = "PBXFileReference"; - path = "ObserveOn.swift"; - sourceTree = ""; - }; - "OBJ_163" = { - isa = "PBXFileReference"; - path = "ObserverBase.swift"; - sourceTree = ""; - }; - "OBJ_164" = { - isa = "PBXFileReference"; - path = "ObserverType.swift"; - sourceTree = ""; - }; - "OBJ_165" = { - isa = "PBXFileReference"; - path = "OperationQueueScheduler.swift"; - sourceTree = ""; - }; - "OBJ_166" = { - isa = "PBXFileReference"; - path = "Optional.swift"; - sourceTree = ""; - }; - "OBJ_167" = { - isa = "PBXFileReference"; - path = "Platform.Darwin.swift"; - sourceTree = ""; - }; - "OBJ_168" = { - isa = "PBXFileReference"; - path = "Platform.Linux.swift"; - sourceTree = ""; - }; - "OBJ_169" = { - isa = "PBXFileReference"; - path = "PrimitiveSequence+Zip+arity.swift"; - sourceTree = ""; - }; - "OBJ_17" = { - isa = "PBXFileReference"; - path = "DeepLinking.swift"; - sourceTree = ""; - }; - "OBJ_170" = { - isa = "PBXFileReference"; - path = "PrimitiveSequence.swift"; - sourceTree = ""; - }; - "OBJ_171" = { - isa = "PBXFileReference"; - path = "PriorityQueue.swift"; - sourceTree = ""; - }; - "OBJ_172" = { - isa = "PBXFileReference"; - path = "Producer.swift"; - sourceTree = ""; - }; - "OBJ_173" = { - isa = "PBXFileReference"; - path = "PublishSubject.swift"; - sourceTree = ""; - }; - "OBJ_174" = { - isa = "PBXFileReference"; - path = "Queue.swift"; - sourceTree = ""; - }; - "OBJ_175" = { - isa = "PBXFileReference"; - path = "Range.swift"; - sourceTree = ""; - }; - "OBJ_176" = { - isa = "PBXFileReference"; - path = "Reactive.swift"; - sourceTree = ""; - }; - "OBJ_177" = { - isa = "PBXFileReference"; - path = "RecursiveLock.swift"; - sourceTree = ""; - }; - "OBJ_178" = { - isa = "PBXFileReference"; - path = "RecursiveScheduler.swift"; - sourceTree = ""; - }; - "OBJ_179" = { - isa = "PBXFileReference"; - path = "Reduce.swift"; - sourceTree = ""; - }; - "OBJ_18" = { - isa = "PBXFileReference"; - path = "GestureRecognizerTarget.swift"; - sourceTree = ""; - }; - "OBJ_180" = { - isa = "PBXFileReference"; - path = "RefCountDisposable.swift"; - sourceTree = ""; - }; - "OBJ_181" = { - isa = "PBXFileReference"; - path = "Repeat.swift"; - sourceTree = ""; - }; - "OBJ_182" = { - isa = "PBXFileReference"; - path = "ReplaySubject.swift"; - sourceTree = ""; - }; - "OBJ_183" = { - isa = "PBXFileReference"; - path = "RetryWhen.swift"; - sourceTree = ""; - }; - "OBJ_184" = { - isa = "PBXFileReference"; - path = "Rx.swift"; - sourceTree = ""; - }; - "OBJ_185" = { - isa = "PBXFileReference"; - path = "RxMutableBox.swift"; - sourceTree = ""; - }; - "OBJ_186" = { - isa = "PBXFileReference"; - path = "Sample.swift"; - sourceTree = ""; - }; - "OBJ_187" = { - isa = "PBXFileReference"; - path = "Scan.swift"; - sourceTree = ""; - }; - "OBJ_188" = { - isa = "PBXFileReference"; - path = "ScheduledDisposable.swift"; - sourceTree = ""; - }; - "OBJ_189" = { - isa = "PBXFileReference"; - path = "ScheduledItem.swift"; - sourceTree = ""; - }; - "OBJ_19" = { - isa = "PBXFileReference"; - path = "InteractiveTransitionAnimation.swift"; - sourceTree = ""; - }; - "OBJ_190" = { - isa = "PBXFileReference"; - path = "ScheduledItemType.swift"; - sourceTree = ""; - }; - "OBJ_191" = { - isa = "PBXFileReference"; - path = "SchedulerServices+Emulation.swift"; - sourceTree = ""; - }; - "OBJ_192" = { - isa = "PBXFileReference"; - path = "SchedulerType.swift"; - sourceTree = ""; - }; - "OBJ_193" = { - isa = "PBXFileReference"; - path = "Sequence.swift"; - sourceTree = ""; - }; - "OBJ_194" = { - isa = "PBXFileReference"; - path = "SerialDispatchQueueScheduler.swift"; - sourceTree = ""; - }; - "OBJ_195" = { - isa = "PBXFileReference"; - path = "SerialDisposable.swift"; - sourceTree = ""; - }; - "OBJ_196" = { - isa = "PBXFileReference"; - path = "ShareReplayScope.swift"; - sourceTree = ""; - }; - "OBJ_197" = { - isa = "PBXFileReference"; - path = "Single.swift"; - sourceTree = ""; - }; - "OBJ_198" = { - isa = "PBXFileReference"; - path = "SingleAssignmentDisposable.swift"; - sourceTree = ""; - }; - "OBJ_199" = { - isa = "PBXFileReference"; - path = "SingleAsync.swift"; - sourceTree = ""; - }; - "OBJ_2" = { - isa = "XCConfigurationList"; - buildConfigurations = ( - "OBJ_3", - "OBJ_4" - ); - defaultConfigurationIsVisible = "0"; - defaultConfigurationName = "Release"; - }; - "OBJ_20" = { - isa = "PBXFileReference"; - path = "InterruptibleTransitionAnimation.swift"; - sourceTree = ""; - }; - "OBJ_200" = { - isa = "PBXFileReference"; - path = "Sink.swift"; - sourceTree = ""; - }; - "OBJ_201" = { - isa = "PBXFileReference"; - path = "Skip.swift"; - sourceTree = ""; - }; - "OBJ_202" = { - isa = "PBXFileReference"; - path = "SkipUntil.swift"; - sourceTree = ""; - }; - "OBJ_203" = { - isa = "PBXFileReference"; - path = "SkipWhile.swift"; - sourceTree = ""; - }; - "OBJ_204" = { - isa = "PBXFileReference"; - path = "StartWith.swift"; - sourceTree = ""; - }; - "OBJ_205" = { - isa = "PBXFileReference"; - path = "SubjectType.swift"; - sourceTree = ""; - }; - "OBJ_206" = { - isa = "PBXFileReference"; - path = "SubscribeOn.swift"; - sourceTree = ""; - }; - "OBJ_207" = { - isa = "PBXFileReference"; - path = "SubscriptionDisposable.swift"; - sourceTree = ""; - }; - "OBJ_208" = { - isa = "PBXFileReference"; - path = "SwiftSupport.swift"; - sourceTree = ""; - }; - "OBJ_209" = { - isa = "PBXFileReference"; - path = "Switch.swift"; - sourceTree = ""; - }; - "OBJ_21" = { - isa = "PBXFileReference"; - path = "NavigationAnimationDelegate.swift"; - sourceTree = ""; - }; - "OBJ_210" = { - isa = "PBXFileReference"; - path = "SwitchIfEmpty.swift"; - sourceTree = ""; - }; - "OBJ_211" = { - isa = "PBXFileReference"; - path = "SynchronizedDisposeType.swift"; - sourceTree = ""; - }; - "OBJ_212" = { - isa = "PBXFileReference"; - path = "SynchronizedOnType.swift"; - sourceTree = ""; - }; - "OBJ_213" = { - isa = "PBXFileReference"; - path = "SynchronizedUnsubscribeType.swift"; - sourceTree = ""; - }; - "OBJ_214" = { - isa = "PBXFileReference"; - path = "TailRecursiveSink.swift"; - sourceTree = ""; - }; - "OBJ_215" = { - isa = "PBXFileReference"; - path = "Take.swift"; - sourceTree = ""; - }; - "OBJ_216" = { - isa = "PBXFileReference"; - path = "TakeLast.swift"; - sourceTree = ""; - }; - "OBJ_217" = { - isa = "PBXFileReference"; - path = "TakeWithPredicate.swift"; - sourceTree = ""; - }; - "OBJ_218" = { - isa = "PBXFileReference"; - path = "Throttle.swift"; - sourceTree = ""; - }; - "OBJ_219" = { - isa = "PBXFileReference"; - path = "Timeout.swift"; - sourceTree = ""; - }; - "OBJ_22" = { - isa = "PBXFileReference"; - path = "NavigationCoordinator.swift"; - sourceTree = ""; - }; - "OBJ_220" = { - isa = "PBXFileReference"; - path = "Timer.swift"; - sourceTree = ""; - }; - "OBJ_221" = { - isa = "PBXFileReference"; - path = "ToArray.swift"; - sourceTree = ""; - }; - "OBJ_222" = { - isa = "PBXFileReference"; - path = "Using.swift"; - sourceTree = ""; - }; - "OBJ_223" = { - isa = "PBXFileReference"; - path = "VirtualTimeConverterType.swift"; - sourceTree = ""; - }; - "OBJ_224" = { - isa = "PBXFileReference"; - path = "VirtualTimeScheduler.swift"; - sourceTree = ""; - }; - "OBJ_225" = { - isa = "PBXFileReference"; - path = "Window.swift"; - sourceTree = ""; - }; - "OBJ_226" = { - isa = "PBXFileReference"; - path = "WithLatestFrom.swift"; - sourceTree = ""; - }; - "OBJ_227" = { - isa = "PBXFileReference"; - path = "WithUnretained.swift"; - sourceTree = ""; - }; - "OBJ_228" = { - isa = "PBXFileReference"; - path = "Zip+Collection.swift"; - sourceTree = ""; - }; - "OBJ_229" = { - isa = "PBXFileReference"; - path = "Zip+arity.swift"; - sourceTree = ""; - }; - "OBJ_23" = { - isa = "PBXFileReference"; - path = "NavigationTransition.swift"; - sourceTree = ""; - }; - "OBJ_230" = { - isa = "PBXFileReference"; - path = "Zip.swift"; - sourceTree = ""; - }; - "OBJ_231" = { - isa = "PBXGroup"; - children = ( - ); - name = "RxTest"; - path = ".build/checkouts/RxSwift/Sources/RxTest"; - sourceTree = "SOURCE_ROOT"; - }; - "OBJ_232" = { - isa = "PBXFileReference"; - explicitFileType = "sourcecode.swift"; - name = "Package.swift"; - path = "/Users/pauljohanneskraft/Documents/QuickBirdStudios/Frameworks/XCoordinator/.build/checkouts/RxSwift/Package.swift"; - sourceTree = ""; - }; - "OBJ_233" = { - isa = "PBXGroup"; - children = ( - "XCoordinator::XCoordinator::Product", - "RxSwift::RxSwift::Product", - "XCoordinator::XCoordinatorTests::Product", - "XCoordinator::XCoordinatorCombine::Product", - "XCoordinator::XCoordinatorRx::Product" - ); - name = "Products"; - path = ""; - sourceTree = "BUILT_PRODUCTS_DIR"; - }; - "OBJ_239" = { - isa = "PBXFileReference"; - path = "Images"; - sourceTree = "SOURCE_ROOT"; - }; - "OBJ_24" = { - isa = "PBXFileReference"; - path = "PageCoordinator.swift"; - sourceTree = ""; - }; - "OBJ_240" = { - isa = "PBXFileReference"; - path = "docs"; - sourceTree = "SOURCE_ROOT"; - }; - "OBJ_241" = { - isa = "PBXFileReference"; - path = "scripts"; - sourceTree = "SOURCE_ROOT"; - }; - "OBJ_242" = { - isa = "PBXFileReference"; - path = "build"; - sourceTree = "SOURCE_ROOT"; - }; - "OBJ_243" = { - isa = "PBXFileReference"; - path = "XCoordinator.podspec"; - sourceTree = ""; - }; - "OBJ_244" = { - isa = "PBXFileReference"; - path = "LICENSE"; - sourceTree = ""; - }; - "OBJ_245" = { - isa = "PBXFileReference"; - path = "README.md"; - sourceTree = ""; - }; - "OBJ_247" = { - isa = "XCConfigurationList"; - buildConfigurations = ( - "OBJ_248", - "OBJ_249" - ); - defaultConfigurationIsVisible = "0"; - defaultConfigurationName = "Release"; - }; - "OBJ_248" = { - isa = "XCBuildConfiguration"; - buildSettings = { - ENABLE_TESTABILITY = "YES"; - FRAMEWORK_SEARCH_PATHS = ( - "$(inherited)", - "$(PLATFORM_DIR)/Developer/Library/Frameworks" - ); - HEADER_SEARCH_PATHS = ( - "$(inherited)" - ); - INFOPLIST_FILE = "XCoordinator.xcodeproj/RxSwift_Info.plist"; - IPHONEOS_DEPLOYMENT_TARGET = "9.0"; - LD_RUNPATH_SEARCH_PATHS = ( - "$(inherited)", - "$(TOOLCHAIN_DIR)/usr/lib/swift/macosx" - ); - MACOSX_DEPLOYMENT_TARGET = "10.10"; - OTHER_CFLAGS = ( - "$(inherited)" - ); - OTHER_LDFLAGS = ( - "$(inherited)" - ); - OTHER_SWIFT_FLAGS = ( - "$(inherited)" - ); - PRODUCT_BUNDLE_IDENTIFIER = "RxSwift"; - PRODUCT_MODULE_NAME = "$(TARGET_NAME:c99extidentifier)"; - PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)"; - SKIP_INSTALL = "YES"; - SWIFT_ACTIVE_COMPILATION_CONDITIONS = ( - "$(inherited)" - ); - SWIFT_VERSION = "5.0"; - TARGET_NAME = "RxSwift"; - TVOS_DEPLOYMENT_TARGET = "9.0"; - WATCHOS_DEPLOYMENT_TARGET = "2.0"; - }; - name = "Debug"; - }; - "OBJ_249" = { - isa = "XCBuildConfiguration"; - buildSettings = { - ENABLE_TESTABILITY = "YES"; - FRAMEWORK_SEARCH_PATHS = ( - "$(inherited)", - "$(PLATFORM_DIR)/Developer/Library/Frameworks" - ); - HEADER_SEARCH_PATHS = ( - "$(inherited)" - ); - INFOPLIST_FILE = "XCoordinator.xcodeproj/RxSwift_Info.plist"; - IPHONEOS_DEPLOYMENT_TARGET = "9.0"; - LD_RUNPATH_SEARCH_PATHS = ( - "$(inherited)", - "$(TOOLCHAIN_DIR)/usr/lib/swift/macosx" - ); - MACOSX_DEPLOYMENT_TARGET = "10.10"; - OTHER_CFLAGS = ( - "$(inherited)" - ); - OTHER_LDFLAGS = ( - "$(inherited)" - ); - OTHER_SWIFT_FLAGS = ( - "$(inherited)" - ); - PRODUCT_BUNDLE_IDENTIFIER = "RxSwift"; - PRODUCT_MODULE_NAME = "$(TARGET_NAME:c99extidentifier)"; - PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)"; - SKIP_INSTALL = "YES"; - SWIFT_ACTIVE_COMPILATION_CONDITIONS = ( - "$(inherited)" - ); - SWIFT_VERSION = "5.0"; - TARGET_NAME = "RxSwift"; - TVOS_DEPLOYMENT_TARGET = "9.0"; - WATCHOS_DEPLOYMENT_TARGET = "2.0"; - }; - name = "Release"; - }; - "OBJ_25" = { - isa = "PBXFileReference"; - path = "PageCoordinatorDataSource.swift"; - sourceTree = ""; - }; - "OBJ_250" = { - isa = "PBXSourcesBuildPhase"; - files = ( - "OBJ_251", - "OBJ_252", - "OBJ_253", - "OBJ_254", - "OBJ_255", - "OBJ_256", - "OBJ_257", - "OBJ_258", - "OBJ_259", - "OBJ_260", - "OBJ_261", - "OBJ_262", - "OBJ_263", - "OBJ_264", - "OBJ_265", - "OBJ_266", - "OBJ_267", - "OBJ_268", - "OBJ_269", - "OBJ_270", - "OBJ_271", - "OBJ_272", - "OBJ_273", - "OBJ_274", - "OBJ_275", - "OBJ_276", - "OBJ_277", - "OBJ_278", - "OBJ_279", - "OBJ_280", - "OBJ_281", - "OBJ_282", - "OBJ_283", - "OBJ_284", - "OBJ_285", - "OBJ_286", - "OBJ_287", - "OBJ_288", - "OBJ_289", - "OBJ_290", - "OBJ_291", - "OBJ_292", - "OBJ_293", - "OBJ_294", - "OBJ_295", - "OBJ_296", - "OBJ_297", - "OBJ_298", - "OBJ_299", - "OBJ_300", - "OBJ_301", - "OBJ_302", - "OBJ_303", - "OBJ_304", - "OBJ_305", - "OBJ_306", - "OBJ_307", - "OBJ_308", - "OBJ_309", - "OBJ_310", - "OBJ_311", - "OBJ_312", - "OBJ_313", - "OBJ_314", - "OBJ_315", - "OBJ_316", - "OBJ_317", - "OBJ_318", - "OBJ_319", - "OBJ_320", - "OBJ_321", - "OBJ_322", - "OBJ_323", - "OBJ_324", - "OBJ_325", - "OBJ_326", - "OBJ_327", - "OBJ_328", - "OBJ_329", - "OBJ_330", - "OBJ_331", - "OBJ_332", - "OBJ_333", - "OBJ_334", - "OBJ_335", - "OBJ_336", - "OBJ_337", - "OBJ_338", - "OBJ_339", - "OBJ_340", - "OBJ_341", - "OBJ_342", - "OBJ_343", - "OBJ_344", - "OBJ_345", - "OBJ_346", - "OBJ_347", - "OBJ_348", - "OBJ_349", - "OBJ_350", - "OBJ_351", - "OBJ_352", - "OBJ_353", - "OBJ_354", - "OBJ_355", - "OBJ_356", - "OBJ_357", - "OBJ_358", - "OBJ_359", - "OBJ_360", - "OBJ_361", - "OBJ_362", - "OBJ_363", - "OBJ_364", - "OBJ_365", - "OBJ_366", - "OBJ_367", - "OBJ_368", - "OBJ_369", - "OBJ_370", - "OBJ_371", - "OBJ_372", - "OBJ_373", - "OBJ_374", - "OBJ_375", - "OBJ_376", - "OBJ_377", - "OBJ_378", - "OBJ_379", - "OBJ_380", - "OBJ_381", - "OBJ_382", - "OBJ_383", - "OBJ_384", - "OBJ_385", - "OBJ_386", - "OBJ_387", - "OBJ_388", - "OBJ_389", - "OBJ_390", - "OBJ_391", - "OBJ_392", - "OBJ_393", - "OBJ_394", - "OBJ_395", - "OBJ_396", - "OBJ_397", - "OBJ_398", - "OBJ_399", - "OBJ_400", - "OBJ_401", - "OBJ_402", - "OBJ_403", - "OBJ_404", - "OBJ_405", - "OBJ_406", - "OBJ_407" - ); - }; - "OBJ_251" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_74"; - }; - "OBJ_252" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_75"; - }; - "OBJ_253" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_76"; - }; - "OBJ_254" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_77"; - }; - "OBJ_255" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_78"; - }; - "OBJ_256" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_79"; - }; - "OBJ_257" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_80"; - }; - "OBJ_258" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_81"; - }; - "OBJ_259" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_82"; - }; - "OBJ_26" = { - isa = "PBXFileReference"; - path = "PageTransition.swift"; - sourceTree = ""; - }; - "OBJ_260" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_83"; - }; - "OBJ_261" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_84"; - }; - "OBJ_262" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_85"; - }; - "OBJ_263" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_86"; - }; - "OBJ_264" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_87"; - }; - "OBJ_265" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_88"; - }; - "OBJ_266" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_89"; - }; - "OBJ_267" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_90"; - }; - "OBJ_268" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_91"; - }; - "OBJ_269" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_92"; - }; - "OBJ_27" = { - isa = "PBXFileReference"; - path = "Presentable.swift"; - sourceTree = ""; - }; - "OBJ_270" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_93"; - }; - "OBJ_271" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_94"; - }; - "OBJ_272" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_95"; - }; - "OBJ_273" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_96"; - }; - "OBJ_274" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_97"; - }; - "OBJ_275" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_98"; - }; - "OBJ_276" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_99"; - }; - "OBJ_277" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_100"; - }; - "OBJ_278" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_101"; - }; - "OBJ_279" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_102"; - }; - "OBJ_28" = { - isa = "PBXFileReference"; - path = "RedirectionRouter.swift"; - sourceTree = ""; - }; - "OBJ_280" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_103"; - }; - "OBJ_281" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_104"; - }; - "OBJ_282" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_105"; - }; - "OBJ_283" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_106"; - }; - "OBJ_284" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_107"; - }; - "OBJ_285" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_108"; - }; - "OBJ_286" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_109"; - }; - "OBJ_287" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_110"; - }; - "OBJ_288" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_111"; - }; - "OBJ_289" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_112"; - }; - "OBJ_29" = { - isa = "PBXFileReference"; - path = "Route.swift"; - sourceTree = ""; - }; - "OBJ_290" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_113"; - }; - "OBJ_291" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_114"; - }; - "OBJ_292" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_115"; - }; - "OBJ_293" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_116"; - }; - "OBJ_294" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_117"; - }; - "OBJ_295" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_118"; - }; - "OBJ_296" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_119"; - }; - "OBJ_297" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_120"; - }; - "OBJ_298" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_121"; - }; - "OBJ_299" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_122"; - }; - "OBJ_3" = { - isa = "XCBuildConfiguration"; - buildSettings = { - CLANG_ENABLE_OBJC_ARC = "YES"; - COMBINE_HIDPI_IMAGES = "YES"; - COPY_PHASE_STRIP = "NO"; - DEBUG_INFORMATION_FORMAT = "dwarf"; - DYLIB_INSTALL_NAME_BASE = "@rpath"; - ENABLE_NS_ASSERTIONS = "YES"; - GCC_OPTIMIZATION_LEVEL = "0"; - GCC_PREPROCESSOR_DEFINITIONS = ( - "$(inherited)", - "SWIFT_PACKAGE=1", - "DEBUG=1" - ); - MACOSX_DEPLOYMENT_TARGET = "10.10"; - ONLY_ACTIVE_ARCH = "YES"; - OTHER_SWIFT_FLAGS = ( - "$(inherited)", - "-DXcode" - ); - PRODUCT_NAME = "$(TARGET_NAME)"; - SDKROOT = "macosx"; - SUPPORTED_PLATFORMS = ( - "macosx", - "iphoneos", - "iphonesimulator", - "appletvos", - "appletvsimulator", - "watchos", - "watchsimulator" - ); - SWIFT_ACTIVE_COMPILATION_CONDITIONS = ( - "$(inherited)", - "SWIFT_PACKAGE", - "DEBUG" - ); - SWIFT_OPTIMIZATION_LEVEL = "-Onone"; - USE_HEADERMAP = "NO"; - }; - name = "Debug"; - }; - "OBJ_30" = { - isa = "PBXFileReference"; - path = "Router.swift"; - sourceTree = ""; - }; - "OBJ_300" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_123"; - }; - "OBJ_301" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_124"; - }; - "OBJ_302" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_125"; - }; - "OBJ_303" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_126"; - }; - "OBJ_304" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_127"; - }; - "OBJ_305" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_128"; - }; - "OBJ_306" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_129"; - }; - "OBJ_307" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_130"; - }; - "OBJ_308" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_131"; - }; - "OBJ_309" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_132"; - }; - "OBJ_31" = { - isa = "PBXFileReference"; - path = "SplitCoordinator.swift"; - sourceTree = ""; - }; - "OBJ_310" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_133"; - }; - "OBJ_311" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_134"; - }; - "OBJ_312" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_135"; - }; - "OBJ_313" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_136"; - }; - "OBJ_314" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_137"; - }; - "OBJ_315" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_138"; - }; - "OBJ_316" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_139"; - }; - "OBJ_317" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_140"; - }; - "OBJ_318" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_141"; - }; - "OBJ_319" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_142"; - }; - "OBJ_32" = { - isa = "PBXFileReference"; - path = "SplitTransition.swift"; - sourceTree = ""; - }; - "OBJ_320" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_143"; - }; - "OBJ_321" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_144"; - }; - "OBJ_322" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_145"; - }; - "OBJ_323" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_146"; - }; - "OBJ_324" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_147"; - }; - "OBJ_325" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_148"; - }; - "OBJ_326" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_149"; - }; - "OBJ_327" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_150"; - }; - "OBJ_328" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_151"; - }; - "OBJ_329" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_152"; - }; - "OBJ_33" = { - isa = "PBXFileReference"; - path = "StaticTransitionAnimation.swift"; - sourceTree = ""; - }; - "OBJ_330" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_153"; - }; - "OBJ_331" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_154"; - }; - "OBJ_332" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_155"; - }; - "OBJ_333" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_156"; - }; - "OBJ_334" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_157"; - }; - "OBJ_335" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_158"; - }; - "OBJ_336" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_159"; - }; - "OBJ_337" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_160"; - }; - "OBJ_338" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_161"; - }; - "OBJ_339" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_162"; - }; - "OBJ_34" = { - isa = "PBXFileReference"; - path = "StrongRouter.swift"; - sourceTree = ""; - }; - "OBJ_340" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_163"; - }; - "OBJ_341" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_164"; - }; - "OBJ_342" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_165"; - }; - "OBJ_343" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_166"; - }; - "OBJ_344" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_167"; - }; - "OBJ_345" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_168"; - }; - "OBJ_346" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_169"; - }; - "OBJ_347" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_170"; - }; - "OBJ_348" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_171"; - }; - "OBJ_349" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_172"; - }; - "OBJ_35" = { - isa = "PBXFileReference"; - path = "TabBarAnimationDelegate.swift"; - sourceTree = ""; - }; - "OBJ_350" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_173"; - }; - "OBJ_351" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_174"; - }; - "OBJ_352" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_175"; - }; - "OBJ_353" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_176"; - }; - "OBJ_354" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_177"; - }; - "OBJ_355" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_178"; - }; - "OBJ_356" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_179"; - }; - "OBJ_357" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_180"; - }; - "OBJ_358" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_181"; - }; - "OBJ_359" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_182"; - }; - "OBJ_36" = { - isa = "PBXFileReference"; - path = "TabBarCoordinator.swift"; - sourceTree = ""; - }; - "OBJ_360" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_183"; - }; - "OBJ_361" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_184"; - }; - "OBJ_362" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_185"; - }; - "OBJ_363" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_186"; - }; - "OBJ_364" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_187"; - }; - "OBJ_365" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_188"; - }; - "OBJ_366" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_189"; - }; - "OBJ_367" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_190"; - }; - "OBJ_368" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_191"; - }; - "OBJ_369" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_192"; - }; - "OBJ_37" = { - isa = "PBXFileReference"; - path = "TabBarTransition.swift"; - sourceTree = ""; - }; - "OBJ_370" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_193"; - }; - "OBJ_371" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_194"; - }; - "OBJ_372" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_195"; - }; - "OBJ_373" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_196"; - }; - "OBJ_374" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_197"; - }; - "OBJ_375" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_198"; - }; - "OBJ_376" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_199"; - }; - "OBJ_377" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_200"; - }; - "OBJ_378" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_201"; - }; - "OBJ_379" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_202"; - }; - "OBJ_38" = { - isa = "PBXFileReference"; - path = "Transition+Init.swift"; - sourceTree = ""; - }; - "OBJ_380" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_203"; - }; - "OBJ_381" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_204"; - }; - "OBJ_382" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_205"; - }; - "OBJ_383" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_206"; - }; - "OBJ_384" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_207"; - }; - "OBJ_385" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_208"; - }; - "OBJ_386" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_209"; - }; - "OBJ_387" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_210"; - }; - "OBJ_388" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_211"; - }; - "OBJ_389" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_212"; - }; - "OBJ_39" = { - isa = "PBXFileReference"; - path = "Transition.swift"; - sourceTree = ""; - }; - "OBJ_390" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_213"; - }; - "OBJ_391" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_214"; - }; - "OBJ_392" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_215"; - }; - "OBJ_393" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_216"; - }; - "OBJ_394" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_217"; - }; - "OBJ_395" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_218"; - }; - "OBJ_396" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_219"; - }; - "OBJ_397" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_220"; - }; - "OBJ_398" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_221"; - }; - "OBJ_399" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_222"; - }; - "OBJ_4" = { - isa = "XCBuildConfiguration"; - buildSettings = { - CLANG_ENABLE_OBJC_ARC = "YES"; - COMBINE_HIDPI_IMAGES = "YES"; - COPY_PHASE_STRIP = "YES"; - DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; - DYLIB_INSTALL_NAME_BASE = "@rpath"; - GCC_OPTIMIZATION_LEVEL = "s"; - GCC_PREPROCESSOR_DEFINITIONS = ( - "$(inherited)", - "SWIFT_PACKAGE=1" - ); - MACOSX_DEPLOYMENT_TARGET = "10.10"; - OTHER_SWIFT_FLAGS = ( - "$(inherited)", - "-DXcode" - ); - PRODUCT_NAME = "$(TARGET_NAME)"; - SDKROOT = "macosx"; - SUPPORTED_PLATFORMS = ( - "macosx", - "iphoneos", - "iphonesimulator", - "appletvos", - "appletvsimulator", - "watchos", - "watchsimulator" - ); - SWIFT_ACTIVE_COMPILATION_CONDITIONS = ( - "$(inherited)", - "SWIFT_PACKAGE" - ); - SWIFT_OPTIMIZATION_LEVEL = "-Owholemodule"; - USE_HEADERMAP = "NO"; - }; - name = "Release"; - }; - "OBJ_40" = { - isa = "PBXFileReference"; - path = "TransitionAnimation.swift"; - sourceTree = ""; - }; - "OBJ_400" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_223"; - }; - "OBJ_401" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_224"; - }; - "OBJ_402" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_225"; - }; - "OBJ_403" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_226"; - }; - "OBJ_404" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_227"; - }; - "OBJ_405" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_228"; - }; - "OBJ_406" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_229"; - }; - "OBJ_407" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_230"; - }; - "OBJ_408" = { - isa = "PBXFrameworksBuildPhase"; - files = ( - ); - }; - "OBJ_41" = { - isa = "PBXFileReference"; - path = "TransitionOptions.swift"; - sourceTree = ""; - }; - "OBJ_410" = { - isa = "XCConfigurationList"; - buildConfigurations = ( - "OBJ_411", - "OBJ_412" - ); - defaultConfigurationIsVisible = "0"; - defaultConfigurationName = "Release"; - }; - "OBJ_411" = { - isa = "XCBuildConfiguration"; - buildSettings = { - LD = "/usr/bin/true"; - OTHER_SWIFT_FLAGS = ( - "-swift-version", - "5", - "-I", - "$(TOOLCHAIN_DIR)/usr/lib/swift/pm/4_2", - "-sdk", - "/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX11.1.sdk", - "-package-description-version", - "5.1.0" - ); - SWIFT_VERSION = "5.0"; - }; - name = "Debug"; - }; - "OBJ_412" = { - isa = "XCBuildConfiguration"; - buildSettings = { - LD = "/usr/bin/true"; - OTHER_SWIFT_FLAGS = ( - "-swift-version", - "5", - "-I", - "$(TOOLCHAIN_DIR)/usr/lib/swift/pm/4_2", - "-sdk", - "/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX11.1.sdk", - "-package-description-version", - "5.1.0" - ); - SWIFT_VERSION = "5.0"; - }; - name = "Release"; - }; - "OBJ_413" = { - isa = "PBXSourcesBuildPhase"; - files = ( - "OBJ_414" - ); - }; - "OBJ_414" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_232"; - }; - "OBJ_416" = { - isa = "XCConfigurationList"; - buildConfigurations = ( - "OBJ_417", - "OBJ_418" - ); - defaultConfigurationIsVisible = "0"; - defaultConfigurationName = "Release"; - }; - "OBJ_417" = { - isa = "XCBuildConfiguration"; - buildSettings = { - ENABLE_TESTABILITY = "YES"; - FRAMEWORK_SEARCH_PATHS = ( - "$(inherited)", - "$(PLATFORM_DIR)/Developer/Library/Frameworks" - ); - HEADER_SEARCH_PATHS = ( - "$(inherited)" - ); - INFOPLIST_FILE = "XCoordinator.xcodeproj/XCoordinator_Info.plist"; - IPHONEOS_DEPLOYMENT_TARGET = "9.0"; - LD_RUNPATH_SEARCH_PATHS = ( - "$(inherited)", - "$(TOOLCHAIN_DIR)/usr/lib/swift/macosx" - ); - MACOSX_DEPLOYMENT_TARGET = "10.10"; - OTHER_CFLAGS = ( - "$(inherited)" - ); - OTHER_LDFLAGS = ( - "$(inherited)" - ); - OTHER_SWIFT_FLAGS = ( - "$(inherited)" - ); - PRODUCT_BUNDLE_IDENTIFIER = "XCoordinator"; - PRODUCT_MODULE_NAME = "$(TARGET_NAME:c99extidentifier)"; - PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)"; - SKIP_INSTALL = "YES"; - SWIFT_ACTIVE_COMPILATION_CONDITIONS = ( - "$(inherited)" - ); - SWIFT_VERSION = "5.0"; - TARGET_NAME = "XCoordinator"; - TVOS_DEPLOYMENT_TARGET = "9.0"; - WATCHOS_DEPLOYMENT_TARGET = "2.0"; - }; - name = "Debug"; - }; - "OBJ_418" = { - isa = "XCBuildConfiguration"; - buildSettings = { - ENABLE_TESTABILITY = "YES"; - FRAMEWORK_SEARCH_PATHS = ( - "$(inherited)", - "$(PLATFORM_DIR)/Developer/Library/Frameworks" - ); - HEADER_SEARCH_PATHS = ( - "$(inherited)" - ); - INFOPLIST_FILE = "XCoordinator.xcodeproj/XCoordinator_Info.plist"; - IPHONEOS_DEPLOYMENT_TARGET = "9.0"; - LD_RUNPATH_SEARCH_PATHS = ( - "$(inherited)", - "$(TOOLCHAIN_DIR)/usr/lib/swift/macosx" - ); - MACOSX_DEPLOYMENT_TARGET = "10.10"; - OTHER_CFLAGS = ( - "$(inherited)" - ); - OTHER_LDFLAGS = ( - "$(inherited)" - ); - OTHER_SWIFT_FLAGS = ( - "$(inherited)" - ); - PRODUCT_BUNDLE_IDENTIFIER = "XCoordinator"; - PRODUCT_MODULE_NAME = "$(TARGET_NAME:c99extidentifier)"; - PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)"; - SKIP_INSTALL = "YES"; - SWIFT_ACTIVE_COMPILATION_CONDITIONS = ( - "$(inherited)" - ); - SWIFT_VERSION = "5.0"; - TARGET_NAME = "XCoordinator"; - TVOS_DEPLOYMENT_TARGET = "9.0"; - WATCHOS_DEPLOYMENT_TARGET = "2.0"; - }; - name = "Release"; - }; - "OBJ_419" = { - isa = "PBXSourcesBuildPhase"; - files = ( - "OBJ_420", - "OBJ_421", - "OBJ_422", - "OBJ_423", - "OBJ_424", - "OBJ_425", - "OBJ_426", - "OBJ_427", - "OBJ_428", - "OBJ_429", - "OBJ_430", - "OBJ_431", - "OBJ_432", - "OBJ_433", - "OBJ_434", - "OBJ_435", - "OBJ_436", - "OBJ_437", - "OBJ_438", - "OBJ_439", - "OBJ_440", - "OBJ_441", - "OBJ_442", - "OBJ_443", - "OBJ_444", - "OBJ_445", - "OBJ_446", - "OBJ_447", - "OBJ_448", - "OBJ_449", - "OBJ_450", - "OBJ_451", - "OBJ_452", - "OBJ_453", - "OBJ_454", - "OBJ_455", - "OBJ_456", - "OBJ_457", - "OBJ_458", - "OBJ_459", - "OBJ_460", - "OBJ_461", - "OBJ_462", - "OBJ_463", - "OBJ_464" - ); - }; - "OBJ_42" = { - isa = "PBXFileReference"; - path = "TransitionPerformer.swift"; - sourceTree = ""; - }; - "OBJ_420" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_9"; - }; - "OBJ_421" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_10"; - }; - "OBJ_422" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_11"; - }; - "OBJ_423" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_12"; - }; - "OBJ_424" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_13"; - }; - "OBJ_425" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_14"; - }; - "OBJ_426" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_15"; - }; - "OBJ_427" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_16"; - }; - "OBJ_428" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_17"; - }; - "OBJ_429" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_18"; - }; - "OBJ_43" = { - isa = "PBXFileReference"; - path = "TransitionProtocol.swift"; - sourceTree = ""; - }; - "OBJ_430" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_19"; - }; - "OBJ_431" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_20"; - }; - "OBJ_432" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_21"; - }; - "OBJ_433" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_22"; - }; - "OBJ_434" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_23"; - }; - "OBJ_435" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_24"; - }; - "OBJ_436" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_25"; - }; - "OBJ_437" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_26"; - }; - "OBJ_438" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_27"; - }; - "OBJ_439" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_28"; - }; - "OBJ_44" = { - isa = "PBXFileReference"; - path = "UINavigationController+Transition.swift"; - sourceTree = ""; - }; - "OBJ_440" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_29"; - }; - "OBJ_441" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_30"; - }; - "OBJ_442" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_31"; - }; - "OBJ_443" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_32"; - }; - "OBJ_444" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_33"; - }; - "OBJ_445" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_34"; - }; - "OBJ_446" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_35"; - }; - "OBJ_447" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_36"; - }; - "OBJ_448" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_37"; - }; - "OBJ_449" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_38"; - }; - "OBJ_45" = { - isa = "PBXFileReference"; - path = "UIPageViewController+Transition.swift"; - sourceTree = ""; - }; - "OBJ_450" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_39"; - }; - "OBJ_451" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_40"; - }; - "OBJ_452" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_41"; - }; - "OBJ_453" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_42"; - }; - "OBJ_454" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_43"; - }; - "OBJ_455" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_44"; - }; - "OBJ_456" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_45"; - }; - "OBJ_457" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_46"; - }; - "OBJ_458" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_47"; - }; - "OBJ_459" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_48"; - }; - "OBJ_46" = { - isa = "PBXFileReference"; - path = "UITabBarController+Transition.swift"; - sourceTree = ""; - }; - "OBJ_460" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_49"; - }; - "OBJ_461" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_50"; - }; - "OBJ_462" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_51"; - }; - "OBJ_463" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_52"; - }; - "OBJ_464" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_53"; - }; - "OBJ_465" = { - isa = "PBXFrameworksBuildPhase"; - files = ( - ); - }; - "OBJ_467" = { - isa = "XCConfigurationList"; - buildConfigurations = ( - "OBJ_468", - "OBJ_469" - ); - defaultConfigurationIsVisible = "0"; - defaultConfigurationName = "Release"; - }; - "OBJ_468" = { - isa = "XCBuildConfiguration"; - buildSettings = { - ENABLE_TESTABILITY = "YES"; - FRAMEWORK_SEARCH_PATHS = ( - "$(inherited)", - "$(PLATFORM_DIR)/Developer/Library/Frameworks" - ); - HEADER_SEARCH_PATHS = ( - "$(inherited)" - ); - INFOPLIST_FILE = "XCoordinator.xcodeproj/XCoordinatorCombine_Info.plist"; - IPHONEOS_DEPLOYMENT_TARGET = "9.0"; - LD_RUNPATH_SEARCH_PATHS = ( - "$(inherited)", - "$(TOOLCHAIN_DIR)/usr/lib/swift/macosx" - ); - MACOSX_DEPLOYMENT_TARGET = "10.10"; - OTHER_CFLAGS = ( - "$(inherited)" - ); - OTHER_LDFLAGS = ( - "$(inherited)" - ); - OTHER_SWIFT_FLAGS = ( - "$(inherited)" - ); - PRODUCT_BUNDLE_IDENTIFIER = "XCoordinatorCombine"; - PRODUCT_MODULE_NAME = "$(TARGET_NAME:c99extidentifier)"; - PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)"; - SKIP_INSTALL = "YES"; - SWIFT_ACTIVE_COMPILATION_CONDITIONS = ( - "$(inherited)" - ); - SWIFT_VERSION = "5.0"; - TARGET_NAME = "XCoordinatorCombine"; - TVOS_DEPLOYMENT_TARGET = "9.0"; - WATCHOS_DEPLOYMENT_TARGET = "2.0"; - }; - name = "Debug"; - }; - "OBJ_469" = { - isa = "XCBuildConfiguration"; - buildSettings = { - ENABLE_TESTABILITY = "YES"; - FRAMEWORK_SEARCH_PATHS = ( - "$(inherited)", - "$(PLATFORM_DIR)/Developer/Library/Frameworks" - ); - HEADER_SEARCH_PATHS = ( - "$(inherited)" - ); - INFOPLIST_FILE = "XCoordinator.xcodeproj/XCoordinatorCombine_Info.plist"; - IPHONEOS_DEPLOYMENT_TARGET = "9.0"; - LD_RUNPATH_SEARCH_PATHS = ( - "$(inherited)", - "$(TOOLCHAIN_DIR)/usr/lib/swift/macosx" - ); - MACOSX_DEPLOYMENT_TARGET = "10.10"; - OTHER_CFLAGS = ( - "$(inherited)" - ); - OTHER_LDFLAGS = ( - "$(inherited)" - ); - OTHER_SWIFT_FLAGS = ( - "$(inherited)" - ); - PRODUCT_BUNDLE_IDENTIFIER = "XCoordinatorCombine"; - PRODUCT_MODULE_NAME = "$(TARGET_NAME:c99extidentifier)"; - PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)"; - SKIP_INSTALL = "YES"; - SWIFT_ACTIVE_COMPILATION_CONDITIONS = ( - "$(inherited)" - ); - SWIFT_VERSION = "5.0"; - TARGET_NAME = "XCoordinatorCombine"; - TVOS_DEPLOYMENT_TARGET = "9.0"; - WATCHOS_DEPLOYMENT_TARGET = "2.0"; - }; - name = "Release"; - }; - "OBJ_47" = { - isa = "PBXFileReference"; - path = "UIView+Store.swift"; - sourceTree = ""; - }; - "OBJ_470" = { - isa = "PBXSourcesBuildPhase"; - files = ( - "OBJ_471" - ); - }; - "OBJ_471" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_55"; - }; - "OBJ_472" = { - isa = "PBXFrameworksBuildPhase"; - files = ( - "OBJ_473" - ); - }; - "OBJ_473" = { - isa = "PBXBuildFile"; - fileRef = "XCoordinator::XCoordinator::Product"; - }; - "OBJ_474" = { - isa = "PBXTargetDependency"; - target = "XCoordinator::XCoordinator"; - }; - "OBJ_476" = { - isa = "XCConfigurationList"; - buildConfigurations = ( - "OBJ_477", - "OBJ_478" - ); - defaultConfigurationIsVisible = "0"; - defaultConfigurationName = "Release"; - }; - "OBJ_477" = { - isa = "XCBuildConfiguration"; - buildSettings = { - LD = "/usr/bin/true"; - OTHER_SWIFT_FLAGS = ( - "-swift-version", - "5", - "-I", - "$(TOOLCHAIN_DIR)/usr/lib/swift/pm/4_2", - "-sdk", - "/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX11.1.sdk", - "-package-description-version", - "5.1.0" - ); - SWIFT_VERSION = "5.0"; - }; - name = "Debug"; - }; - "OBJ_478" = { - isa = "XCBuildConfiguration"; - buildSettings = { - LD = "/usr/bin/true"; - OTHER_SWIFT_FLAGS = ( - "-swift-version", - "5", - "-I", - "$(TOOLCHAIN_DIR)/usr/lib/swift/pm/4_2", - "-sdk", - "/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX11.1.sdk", - "-package-description-version", - "5.1.0" - ); - SWIFT_VERSION = "5.0"; - }; - name = "Release"; - }; - "OBJ_479" = { - isa = "PBXSourcesBuildPhase"; - files = ( - "OBJ_480" - ); - }; - "OBJ_48" = { - isa = "PBXFileReference"; - path = "UIViewController+Transition.swift"; - sourceTree = ""; - }; - "OBJ_480" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_6"; - }; - "OBJ_482" = { - isa = "XCConfigurationList"; - buildConfigurations = ( - "OBJ_483", - "OBJ_484" - ); - defaultConfigurationIsVisible = "0"; - defaultConfigurationName = "Release"; - }; - "OBJ_483" = { - isa = "XCBuildConfiguration"; - buildSettings = { - }; - name = "Debug"; - }; - "OBJ_484" = { - isa = "XCBuildConfiguration"; - buildSettings = { - }; - name = "Release"; - }; - "OBJ_485" = { - isa = "PBXTargetDependency"; - target = "XCoordinator::XCoordinatorTests"; - }; - "OBJ_488" = { - isa = "XCConfigurationList"; - buildConfigurations = ( - "OBJ_489", - "OBJ_490" - ); - defaultConfigurationIsVisible = "0"; - defaultConfigurationName = "Release"; - }; - "OBJ_489" = { - isa = "XCBuildConfiguration"; - buildSettings = { - ENABLE_TESTABILITY = "YES"; - FRAMEWORK_SEARCH_PATHS = ( - "$(inherited)", - "$(PLATFORM_DIR)/Developer/Library/Frameworks" - ); - HEADER_SEARCH_PATHS = ( - "$(inherited)" - ); - INFOPLIST_FILE = "XCoordinator.xcodeproj/XCoordinatorRx_Info.plist"; - IPHONEOS_DEPLOYMENT_TARGET = "9.0"; - LD_RUNPATH_SEARCH_PATHS = ( - "$(inherited)", - "$(TOOLCHAIN_DIR)/usr/lib/swift/macosx" - ); - MACOSX_DEPLOYMENT_TARGET = "10.10"; - OTHER_CFLAGS = ( - "$(inherited)" - ); - OTHER_LDFLAGS = ( - "$(inherited)" - ); - OTHER_SWIFT_FLAGS = ( - "$(inherited)" - ); - PRODUCT_BUNDLE_IDENTIFIER = "XCoordinatorRx"; - PRODUCT_MODULE_NAME = "$(TARGET_NAME:c99extidentifier)"; - PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)"; - SKIP_INSTALL = "YES"; - SWIFT_ACTIVE_COMPILATION_CONDITIONS = ( - "$(inherited)" - ); - SWIFT_VERSION = "5.0"; - TARGET_NAME = "XCoordinatorRx"; - TVOS_DEPLOYMENT_TARGET = "9.0"; - WATCHOS_DEPLOYMENT_TARGET = "2.0"; - }; - name = "Debug"; - }; - "OBJ_49" = { - isa = "PBXFileReference"; - path = "UnownedErased+Router.swift"; - sourceTree = ""; - }; - "OBJ_490" = { - isa = "XCBuildConfiguration"; - buildSettings = { - ENABLE_TESTABILITY = "YES"; - FRAMEWORK_SEARCH_PATHS = ( - "$(inherited)", - "$(PLATFORM_DIR)/Developer/Library/Frameworks" - ); - HEADER_SEARCH_PATHS = ( - "$(inherited)" - ); - INFOPLIST_FILE = "XCoordinator.xcodeproj/XCoordinatorRx_Info.plist"; - IPHONEOS_DEPLOYMENT_TARGET = "9.0"; - LD_RUNPATH_SEARCH_PATHS = ( - "$(inherited)", - "$(TOOLCHAIN_DIR)/usr/lib/swift/macosx" - ); - MACOSX_DEPLOYMENT_TARGET = "10.10"; - OTHER_CFLAGS = ( - "$(inherited)" - ); - OTHER_LDFLAGS = ( - "$(inherited)" - ); - OTHER_SWIFT_FLAGS = ( - "$(inherited)" - ); - PRODUCT_BUNDLE_IDENTIFIER = "XCoordinatorRx"; - PRODUCT_MODULE_NAME = "$(TARGET_NAME:c99extidentifier)"; - PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)"; - SKIP_INSTALL = "YES"; - SWIFT_ACTIVE_COMPILATION_CONDITIONS = ( - "$(inherited)" - ); - SWIFT_VERSION = "5.0"; - TARGET_NAME = "XCoordinatorRx"; - TVOS_DEPLOYMENT_TARGET = "9.0"; - WATCHOS_DEPLOYMENT_TARGET = "2.0"; - }; - name = "Release"; - }; - "OBJ_491" = { - isa = "PBXSourcesBuildPhase"; - files = ( - "OBJ_492" - ); - }; - "OBJ_492" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_57"; - }; - "OBJ_493" = { - isa = "PBXFrameworksBuildPhase"; - files = ( - "OBJ_494", - "OBJ_495" - ); - }; - "OBJ_494" = { - isa = "PBXBuildFile"; - fileRef = "RxSwift::RxSwift::Product"; - }; - "OBJ_495" = { - isa = "PBXBuildFile"; - fileRef = "XCoordinator::XCoordinator::Product"; - }; - "OBJ_496" = { - isa = "PBXTargetDependency"; - target = "RxSwift::RxSwift"; - }; - "OBJ_497" = { - isa = "PBXTargetDependency"; - target = "XCoordinator::XCoordinator"; - }; - "OBJ_498" = { - isa = "XCConfigurationList"; - buildConfigurations = ( - "OBJ_499", - "OBJ_500" - ); - defaultConfigurationIsVisible = "0"; - defaultConfigurationName = "Release"; - }; - "OBJ_499" = { - isa = "XCBuildConfiguration"; - buildSettings = { - CLANG_ENABLE_MODULES = "YES"; - EMBEDDED_CONTENT_CONTAINS_SWIFT = "YES"; - FRAMEWORK_SEARCH_PATHS = ( - "$(inherited)", - "$(PLATFORM_DIR)/Developer/Library/Frameworks" - ); - HEADER_SEARCH_PATHS = ( - "$(inherited)" - ); - INFOPLIST_FILE = "XCoordinator.xcodeproj/XCoordinatorTests_Info.plist"; - IPHONEOS_DEPLOYMENT_TARGET = "14.0"; - LD_RUNPATH_SEARCH_PATHS = ( - "$(inherited)", - "@loader_path/../Frameworks", - "@loader_path/Frameworks" - ); - MACOSX_DEPLOYMENT_TARGET = "10.15"; - OTHER_CFLAGS = ( - "$(inherited)" - ); - OTHER_LDFLAGS = ( - "$(inherited)" - ); - OTHER_SWIFT_FLAGS = ( - "$(inherited)" - ); - SWIFT_ACTIVE_COMPILATION_CONDITIONS = ( - "$(inherited)" - ); - SWIFT_VERSION = "5.0"; - TARGET_NAME = "XCoordinatorTests"; - TVOS_DEPLOYMENT_TARGET = "9.0"; - WATCHOS_DEPLOYMENT_TARGET = "2.0"; - }; - name = "Debug"; - }; - "OBJ_5" = { - isa = "PBXGroup"; - children = ( - "OBJ_6", - "OBJ_7", - "OBJ_58", - "OBJ_67", - "OBJ_233", - "OBJ_239", - "OBJ_240", - "OBJ_241", - "OBJ_242", - "OBJ_243", - "OBJ_244", - "OBJ_245" - ); - path = ""; - sourceTree = ""; - }; - "OBJ_50" = { - isa = "PBXFileReference"; - path = "UnownedErased.swift"; - sourceTree = ""; - }; - "OBJ_500" = { - isa = "XCBuildConfiguration"; - buildSettings = { - CLANG_ENABLE_MODULES = "YES"; - EMBEDDED_CONTENT_CONTAINS_SWIFT = "YES"; - FRAMEWORK_SEARCH_PATHS = ( - "$(inherited)", - "$(PLATFORM_DIR)/Developer/Library/Frameworks" - ); - HEADER_SEARCH_PATHS = ( - "$(inherited)" - ); - INFOPLIST_FILE = "XCoordinator.xcodeproj/XCoordinatorTests_Info.plist"; - IPHONEOS_DEPLOYMENT_TARGET = "14.0"; - LD_RUNPATH_SEARCH_PATHS = ( - "$(inherited)", - "@loader_path/../Frameworks", - "@loader_path/Frameworks" - ); - MACOSX_DEPLOYMENT_TARGET = "10.15"; - OTHER_CFLAGS = ( - "$(inherited)" - ); - OTHER_LDFLAGS = ( - "$(inherited)" - ); - OTHER_SWIFT_FLAGS = ( - "$(inherited)" - ); - SWIFT_ACTIVE_COMPILATION_CONDITIONS = ( - "$(inherited)" - ); - SWIFT_VERSION = "5.0"; - TARGET_NAME = "XCoordinatorTests"; - TVOS_DEPLOYMENT_TARGET = "9.0"; - WATCHOS_DEPLOYMENT_TARGET = "2.0"; - }; - name = "Release"; - }; - "OBJ_501" = { - isa = "PBXSourcesBuildPhase"; - files = ( - "OBJ_502", - "OBJ_503", - "OBJ_504", - "OBJ_505", - "OBJ_506", - "OBJ_507" - ); - }; - "OBJ_502" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_61"; - }; - "OBJ_503" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_62"; - }; - "OBJ_504" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_63"; - }; - "OBJ_505" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_64"; - }; - "OBJ_506" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_65"; - }; - "OBJ_507" = { - isa = "PBXBuildFile"; - fileRef = "OBJ_66"; - }; - "OBJ_508" = { - isa = "PBXFrameworksBuildPhase"; - files = ( - "OBJ_509", - "OBJ_510", - "OBJ_511" - ); - }; - "OBJ_509" = { - isa = "PBXBuildFile"; - fileRef = "XCoordinator::XCoordinatorRx::Product"; - }; - "OBJ_51" = { - isa = "PBXFileReference"; - path = "ViewCoordinator.swift"; - sourceTree = ""; - }; - "OBJ_510" = { - isa = "PBXBuildFile"; - fileRef = "RxSwift::RxSwift::Product"; - }; - "OBJ_511" = { - isa = "PBXBuildFile"; - fileRef = "XCoordinator::XCoordinator::Product"; - }; - "OBJ_512" = { - isa = "PBXTargetDependency"; - target = "XCoordinator::XCoordinatorRx"; - }; - "OBJ_513" = { - isa = "PBXTargetDependency"; - target = "RxSwift::RxSwift"; - }; - "OBJ_514" = { - isa = "PBXTargetDependency"; - target = "XCoordinator::XCoordinator"; - }; - "OBJ_52" = { - isa = "PBXFileReference"; - path = "WeakErased+Router.swift"; - sourceTree = ""; - }; - "OBJ_53" = { - isa = "PBXFileReference"; - path = "WeakErased.swift"; - sourceTree = ""; - }; - "OBJ_54" = { - isa = "PBXGroup"; - children = ( - "OBJ_55" - ); - name = "XCoordinatorCombine"; - path = "Sources/XCoordinatorCombine"; - sourceTree = "SOURCE_ROOT"; - }; - "OBJ_55" = { - isa = "PBXFileReference"; - path = "Router+Combine.swift"; - sourceTree = ""; - }; - "OBJ_56" = { - isa = "PBXGroup"; - children = ( - "OBJ_57" - ); - name = "XCoordinatorRx"; - path = "Sources/XCoordinatorRx"; - sourceTree = "SOURCE_ROOT"; - }; - "OBJ_57" = { - isa = "PBXFileReference"; - path = "Router+Rx.swift"; - sourceTree = ""; - }; - "OBJ_58" = { - isa = "PBXGroup"; - children = ( - "OBJ_59" - ); - name = "Tests"; - path = ""; - sourceTree = "SOURCE_ROOT"; - }; - "OBJ_59" = { - isa = "PBXGroup"; - children = ( - "OBJ_60", - "OBJ_61", - "OBJ_62", - "OBJ_63", - "OBJ_64", - "OBJ_65", - "OBJ_66" - ); - name = "XCoordinatorTests"; - path = "Tests/XCoordinatorTests"; - sourceTree = "SOURCE_ROOT"; - }; - "OBJ_6" = { - isa = "PBXFileReference"; - explicitFileType = "sourcecode.swift"; - path = "Package.swift"; - sourceTree = ""; - }; - "OBJ_60" = { - isa = "PBXFileReference"; - path = "XCoordinatorTests.xctestplan"; - sourceTree = ""; - }; - "OBJ_61" = { - isa = "PBXFileReference"; - path = "AnimationTests.swift"; - sourceTree = ""; - }; - "OBJ_62" = { - isa = "PBXFileReference"; - path = "TestAnimation.swift"; - sourceTree = ""; - }; - "OBJ_63" = { - isa = "PBXFileReference"; - path = "TestRoute.swift"; - sourceTree = ""; - }; - "OBJ_64" = { - isa = "PBXFileReference"; - path = "TransitionTests.swift"; - sourceTree = ""; - }; - "OBJ_65" = { - isa = "PBXFileReference"; - path = "XCTestManifests.swift"; - sourceTree = ""; - }; - "OBJ_66" = { - isa = "PBXFileReference"; - path = "XCText+Extras.swift"; - sourceTree = ""; - }; - "OBJ_67" = { - isa = "PBXGroup"; - children = ( - "OBJ_68" - ); - name = "Dependencies"; - path = ""; - sourceTree = ""; - }; - "OBJ_68" = { - isa = "PBXGroup"; - children = ( - "OBJ_69", - "OBJ_70", - "OBJ_71", - "OBJ_72", - "OBJ_73", - "OBJ_231", - "OBJ_232" - ); - name = "RxSwift 6.1.0"; - path = ""; - sourceTree = "SOURCE_ROOT"; - }; - "OBJ_69" = { - isa = "PBXGroup"; - children = ( - ); - name = "RxBlocking"; - path = ".build/checkouts/RxSwift/Sources/RxBlocking"; - sourceTree = "SOURCE_ROOT"; - }; - "OBJ_7" = { - isa = "PBXGroup"; - children = ( - "OBJ_8", - "OBJ_54", - "OBJ_56" - ); - name = "Sources"; - path = ""; - sourceTree = "SOURCE_ROOT"; - }; - "OBJ_70" = { - isa = "PBXGroup"; - children = ( - ); - name = "RxCocoa"; - path = ".build/checkouts/RxSwift/Sources/RxCocoa"; - sourceTree = "SOURCE_ROOT"; - }; - "OBJ_71" = { - isa = "PBXGroup"; - children = ( - ); - name = "RxCocoaRuntime"; - path = ".build/checkouts/RxSwift/Sources/RxCocoaRuntime"; - sourceTree = "SOURCE_ROOT"; - }; - "OBJ_72" = { - isa = "PBXGroup"; - children = ( - ); - name = "RxRelay"; - path = ".build/checkouts/RxSwift/Sources/RxRelay"; - sourceTree = "SOURCE_ROOT"; - }; - "OBJ_73" = { - isa = "PBXGroup"; - children = ( - "OBJ_74", - "OBJ_75", - "OBJ_76", - "OBJ_77", - "OBJ_78", - "OBJ_79", - "OBJ_80", - "OBJ_81", - "OBJ_82", - "OBJ_83", - "OBJ_84", - "OBJ_85", - "OBJ_86", - "OBJ_87", - "OBJ_88", - "OBJ_89", - "OBJ_90", - "OBJ_91", - "OBJ_92", - "OBJ_93", - "OBJ_94", - "OBJ_95", - "OBJ_96", - "OBJ_97", - "OBJ_98", - "OBJ_99", - "OBJ_100", - "OBJ_101", - "OBJ_102", - "OBJ_103", - "OBJ_104", - "OBJ_105", - "OBJ_106", - "OBJ_107", - "OBJ_108", - "OBJ_109", - "OBJ_110", - "OBJ_111", - "OBJ_112", - "OBJ_113", - "OBJ_114", - "OBJ_115", - "OBJ_116", - "OBJ_117", - "OBJ_118", - "OBJ_119", - "OBJ_120", - "OBJ_121", - "OBJ_122", - "OBJ_123", - "OBJ_124", - "OBJ_125", - "OBJ_126", - "OBJ_127", - "OBJ_128", - "OBJ_129", - "OBJ_130", - "OBJ_131", - "OBJ_132", - "OBJ_133", - "OBJ_134", - "OBJ_135", - "OBJ_136", - "OBJ_137", - "OBJ_138", - "OBJ_139", - "OBJ_140", - "OBJ_141", - "OBJ_142", - "OBJ_143", - "OBJ_144", - "OBJ_145", - "OBJ_146", - "OBJ_147", - "OBJ_148", - "OBJ_149", - "OBJ_150", - "OBJ_151", - "OBJ_152", - "OBJ_153", - "OBJ_154", - "OBJ_155", - "OBJ_156", - "OBJ_157", - "OBJ_158", - "OBJ_159", - "OBJ_160", - "OBJ_161", - "OBJ_162", - "OBJ_163", - "OBJ_164", - "OBJ_165", - "OBJ_166", - "OBJ_167", - "OBJ_168", - "OBJ_169", - "OBJ_170", - "OBJ_171", - "OBJ_172", - "OBJ_173", - "OBJ_174", - "OBJ_175", - "OBJ_176", - "OBJ_177", - "OBJ_178", - "OBJ_179", - "OBJ_180", - "OBJ_181", - "OBJ_182", - "OBJ_183", - "OBJ_184", - "OBJ_185", - "OBJ_186", - "OBJ_187", - "OBJ_188", - "OBJ_189", - "OBJ_190", - "OBJ_191", - "OBJ_192", - "OBJ_193", - "OBJ_194", - "OBJ_195", - "OBJ_196", - "OBJ_197", - "OBJ_198", - "OBJ_199", - "OBJ_200", - "OBJ_201", - "OBJ_202", - "OBJ_203", - "OBJ_204", - "OBJ_205", - "OBJ_206", - "OBJ_207", - "OBJ_208", - "OBJ_209", - "OBJ_210", - "OBJ_211", - "OBJ_212", - "OBJ_213", - "OBJ_214", - "OBJ_215", - "OBJ_216", - "OBJ_217", - "OBJ_218", - "OBJ_219", - "OBJ_220", - "OBJ_221", - "OBJ_222", - "OBJ_223", - "OBJ_224", - "OBJ_225", - "OBJ_226", - "OBJ_227", - "OBJ_228", - "OBJ_229", - "OBJ_230" - ); - name = "RxSwift"; - path = ".build/checkouts/RxSwift/Sources/RxSwift"; - sourceTree = "SOURCE_ROOT"; - }; - "OBJ_74" = { - isa = "PBXFileReference"; - path = "AddRef.swift"; - sourceTree = ""; - }; - "OBJ_75" = { - isa = "PBXFileReference"; - path = "Amb.swift"; - sourceTree = ""; - }; - "OBJ_76" = { - isa = "PBXFileReference"; - path = "AnonymousDisposable.swift"; - sourceTree = ""; - }; - "OBJ_77" = { - isa = "PBXFileReference"; - path = "AnonymousObserver.swift"; - sourceTree = ""; - }; - "OBJ_78" = { - isa = "PBXFileReference"; - path = "AnyObserver.swift"; - sourceTree = ""; - }; - "OBJ_79" = { - isa = "PBXFileReference"; - path = "AsMaybe.swift"; - sourceTree = ""; - }; - "OBJ_8" = { - isa = "PBXGroup"; - children = ( - "OBJ_9", - "OBJ_10", - "OBJ_11", - "OBJ_12", - "OBJ_13", - "OBJ_14", - "OBJ_15", - "OBJ_16", - "OBJ_17", - "OBJ_18", - "OBJ_19", - "OBJ_20", - "OBJ_21", - "OBJ_22", - "OBJ_23", - "OBJ_24", - "OBJ_25", - "OBJ_26", - "OBJ_27", - "OBJ_28", - "OBJ_29", - "OBJ_30", - "OBJ_31", - "OBJ_32", - "OBJ_33", - "OBJ_34", - "OBJ_35", - "OBJ_36", - "OBJ_37", - "OBJ_38", - "OBJ_39", - "OBJ_40", - "OBJ_41", - "OBJ_42", - "OBJ_43", - "OBJ_44", - "OBJ_45", - "OBJ_46", - "OBJ_47", - "OBJ_48", - "OBJ_49", - "OBJ_50", - "OBJ_51", - "OBJ_52", - "OBJ_53" - ); - name = "XCoordinator"; - path = "Sources/XCoordinator"; - sourceTree = "SOURCE_ROOT"; - }; - "OBJ_80" = { - isa = "PBXFileReference"; - path = "AsSingle.swift"; - sourceTree = ""; - }; - "OBJ_81" = { - isa = "PBXFileReference"; - path = "AsyncLock.swift"; - sourceTree = ""; - }; - "OBJ_82" = { - isa = "PBXFileReference"; - path = "AsyncSubject.swift"; - sourceTree = ""; - }; - "OBJ_83" = { - isa = "PBXFileReference"; - path = "AtomicInt.swift"; - sourceTree = ""; - }; - "OBJ_84" = { - isa = "PBXFileReference"; - path = "Bag+Rx.swift"; - sourceTree = ""; - }; - "OBJ_85" = { - isa = "PBXFileReference"; - path = "Bag.swift"; - sourceTree = ""; - }; - "OBJ_86" = { - isa = "PBXFileReference"; - path = "BehaviorSubject.swift"; - sourceTree = ""; - }; - "OBJ_87" = { - isa = "PBXFileReference"; - path = "BinaryDisposable.swift"; - sourceTree = ""; - }; - "OBJ_88" = { - isa = "PBXFileReference"; - path = "Binder.swift"; - sourceTree = ""; - }; - "OBJ_89" = { - isa = "PBXFileReference"; - path = "BooleanDisposable.swift"; - sourceTree = ""; - }; - "OBJ_9" = { - isa = "PBXFileReference"; - path = "Animation.swift"; - sourceTree = ""; - }; - "OBJ_90" = { - isa = "PBXFileReference"; - path = "Buffer.swift"; - sourceTree = ""; - }; - "OBJ_91" = { - isa = "PBXFileReference"; - path = "Cancelable.swift"; - sourceTree = ""; - }; - "OBJ_92" = { - isa = "PBXFileReference"; - path = "Catch.swift"; - sourceTree = ""; - }; - "OBJ_93" = { - isa = "PBXFileReference"; - path = "CombineLatest+Collection.swift"; - sourceTree = ""; - }; - "OBJ_94" = { - isa = "PBXFileReference"; - path = "CombineLatest+arity.swift"; - sourceTree = ""; - }; - "OBJ_95" = { - isa = "PBXFileReference"; - path = "CombineLatest.swift"; - sourceTree = ""; - }; - "OBJ_96" = { - isa = "PBXFileReference"; - path = "CompactMap.swift"; - sourceTree = ""; - }; - "OBJ_97" = { - isa = "PBXFileReference"; - path = "Completable+AndThen.swift"; - sourceTree = ""; - }; - "OBJ_98" = { - isa = "PBXFileReference"; - path = "Completable.swift"; - sourceTree = ""; - }; - "OBJ_99" = { - isa = "PBXFileReference"; - path = "CompositeDisposable.swift"; - sourceTree = ""; - }; - "RxSwift::RxSwift" = { - isa = "PBXNativeTarget"; - buildConfigurationList = "OBJ_247"; - buildPhases = ( - "OBJ_250", - "OBJ_408" - ); - dependencies = ( - ); - name = "RxSwift"; - productName = "RxSwift"; - productReference = "RxSwift::RxSwift::Product"; - productType = "com.apple.product-type.framework"; - }; - "RxSwift::RxSwift::Product" = { - isa = "PBXFileReference"; - path = "RxSwift.framework"; - sourceTree = "BUILT_PRODUCTS_DIR"; - }; - "RxSwift::SwiftPMPackageDescription" = { - isa = "PBXNativeTarget"; - buildConfigurationList = "OBJ_410"; - buildPhases = ( - "OBJ_413" - ); - dependencies = ( - ); - name = "RxSwiftPackageDescription"; - productName = "RxSwiftPackageDescription"; - productType = "com.apple.product-type.framework"; - }; - "XCoordinator::SwiftPMPackageDescription" = { - isa = "PBXNativeTarget"; - buildConfigurationList = "OBJ_476"; - buildPhases = ( - "OBJ_479" - ); - dependencies = ( - ); - name = "XCoordinatorPackageDescription"; - productName = "XCoordinatorPackageDescription"; - productType = "com.apple.product-type.framework"; - }; - "XCoordinator::XCoordinator" = { - isa = "PBXNativeTarget"; - buildConfigurationList = "OBJ_416"; - buildPhases = ( - "OBJ_419", - "OBJ_465" - ); - dependencies = ( - ); - name = "XCoordinator"; - productName = "XCoordinator"; - productReference = "XCoordinator::XCoordinator::Product"; - productType = "com.apple.product-type.framework"; - }; - "XCoordinator::XCoordinator::Product" = { - isa = "PBXFileReference"; - path = "XCoordinator.framework"; - sourceTree = "BUILT_PRODUCTS_DIR"; - }; - "XCoordinator::XCoordinatorCombine" = { - isa = "PBXNativeTarget"; - buildConfigurationList = "OBJ_467"; - buildPhases = ( - "OBJ_470", - "OBJ_472" - ); - dependencies = ( - "OBJ_474" - ); - name = "XCoordinatorCombine"; - productName = "XCoordinatorCombine"; - productReference = "XCoordinator::XCoordinatorCombine::Product"; - productType = "com.apple.product-type.framework"; - }; - "XCoordinator::XCoordinatorCombine::Product" = { - isa = "PBXFileReference"; - path = "XCoordinatorCombine.framework"; - sourceTree = "BUILT_PRODUCTS_DIR"; - }; - "XCoordinator::XCoordinatorPackageTests::ProductTarget" = { - isa = "PBXAggregateTarget"; - buildConfigurationList = "OBJ_482"; - buildPhases = ( - ); - dependencies = ( - "OBJ_485" - ); - name = "XCoordinatorPackageTests"; - productName = "XCoordinatorPackageTests"; - }; - "XCoordinator::XCoordinatorRx" = { - isa = "PBXNativeTarget"; - buildConfigurationList = "OBJ_488"; - buildPhases = ( - "OBJ_491", - "OBJ_493" - ); - dependencies = ( - "OBJ_496", - "OBJ_497" - ); - name = "XCoordinatorRx"; - productName = "XCoordinatorRx"; - productReference = "XCoordinator::XCoordinatorRx::Product"; - productType = "com.apple.product-type.framework"; - }; - "XCoordinator::XCoordinatorRx::Product" = { - isa = "PBXFileReference"; - path = "XCoordinatorRx.framework"; - sourceTree = "BUILT_PRODUCTS_DIR"; - }; - "XCoordinator::XCoordinatorTests" = { - isa = "PBXNativeTarget"; - buildConfigurationList = "OBJ_498"; - buildPhases = ( - "OBJ_501", - "OBJ_508" - ); - dependencies = ( - "OBJ_512", - "OBJ_513", - "OBJ_514" - ); - name = "XCoordinatorTests"; - productName = "XCoordinatorTests"; - productReference = "XCoordinator::XCoordinatorTests::Product"; - productType = "com.apple.product-type.bundle.unit-test"; - }; - "XCoordinator::XCoordinatorTests::Product" = { - isa = "PBXFileReference"; - path = "XCoordinatorTests.xctest"; - sourceTree = "BUILT_PRODUCTS_DIR"; - }; - }; - rootObject = "OBJ_1"; -} diff --git a/XCoordinator.xcodeproj/xcshareddata/xcschemes/XCoordinator-Package.xcscheme b/XCoordinator.xcodeproj/xcshareddata/xcschemes/XCoordinator-Package.xcscheme deleted file mode 100644 index 4b3755f7..00000000 --- a/XCoordinator.xcodeproj/xcshareddata/xcschemes/XCoordinator-Package.xcscheme +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/XCoordinator.xcodeproj/xcshareddata/xcschemes/XCoordinatorCombine.xcscheme b/XCoordinator.xcodeproj/xcshareddata/xcschemes/XCoordinatorCombine.xcscheme deleted file mode 100644 index 3f04dbe4..00000000 --- a/XCoordinator.xcodeproj/xcshareddata/xcschemes/XCoordinatorCombine.xcscheme +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/XCoordinator.xcodeproj/xcshareddata/xcschemes/XCoordinatorRx.xcscheme b/XCoordinator.xcodeproj/xcshareddata/xcschemes/XCoordinatorRx.xcscheme deleted file mode 100644 index 65c39839..00000000 --- a/XCoordinator.xcodeproj/xcshareddata/xcschemes/XCoordinatorRx.xcscheme +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/XCoordinator.xcodeproj/xcshareddata/xcschemes/XCoordinatorTests.xcscheme b/XCoordinator.xcodeproj/xcshareddata/xcschemes/XCoordinatorTests.xcscheme deleted file mode 100644 index 2e70643a..00000000 --- a/XCoordinator.xcodeproj/xcshareddata/xcschemes/XCoordinatorTests.xcscheme +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/Classes.html b/docs/Classes.html deleted file mode 100644 index fa66b7be..00000000 --- a/docs/Classes.html +++ /dev/null @@ -1,950 +0,0 @@ - - - - Classes Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - Classes Reference -

- -
- -
- -
-
-

Classes

-

The following classes are available globally.

- -
-
- -
-
-
-
    -
  • -
    - - - - Animation - -
    -
    -
    -
    -
    -
    -

    Animation is used to set presentation and dismissal animations for presentables.

    - -

    Depending on the transition in use, different properties of a UIViewController are set to make sure the transition animation is used.

    -
    -

    Note

    -

    To not override the previously set Animation, use nil when initializing a transition.

    - -

    Make sure to hold a strong reference to the Animation object, as it is only held by a weak reference.

    - -
    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open class Animation : NSObject
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - AnyCoordinator - -
    -
    -
    -
    -
    -
    -

    AnyCoordinator is a type-erased Coordinator (RouteType & TransitionType) and -can be used as an abstraction from a specific coordinator class while still specifying -TransitionType and RouteType.

    -
    -

    Note

    - If you do not want/need to specify TransitionType, you might want to look into the -different router abstractions StrongRouter, UnownedRouter and WeakRouter. -See AnyTransitionPerformer to further abstract from RouteType. - -
    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public class AnyCoordinator<RouteType, TransitionType> : Coordinator where RouteType : Route, TransitionType : TransitionProtocol
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • - -
    -
    -
    -
    -
    -

    AnyTransitionPerformer can be used as an abstraction from a specific TransitionPerformer implementation -without losing type information about its TransitionType.

    - -

    This type abstraction can be especially helpful when performing transitions. -AnyTransitionPerformer abstracts away any implementation specific details and reduces coordinators to the capabilities -of the TransitionPerformer protocol.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public class AnyTransitionPerformer<TransitionType> : TransitionPerformer where TransitionType : TransitionProtocol
    - -
    -
    -
    -
    -
    • -
-
-
- -
-
-
    -
  • -
    - - - - BasicCoordinator - -
    -
    -
    -
    -
    -
    -

    BasicCoordinator is a coordinator class that can be used without subclassing.

    - -

    Although subclassing of coordinators is encouraged for more complex cases, a BasicCoordinator can easily -be created by only providing a prepareTransition closure, an initialRoute and an initialLoadingType.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open class BasicCoordinator<RouteType, TransitionType> : BaseCoordinator<RouteType, TransitionType> where RouteType : Route, TransitionType : TransitionProtocol
    - -
    -
    -
    -
    -
    • -
-
-
- -
-
- -
-
-
    -
  • - -
    -
    -
    -
    -
    -

    NavigationAnimationDelegate is used as the delegate of a NavigationCoordinator’s rootViewController -to allow for push-transitions to specify animations.

    - -

    NavigationAnimationDelegate conforms to the UINavigationControllerDelegate protocol -and is intended for use as the delegate of one navigation controller only.

    -
    -

    Note

    - Do not override the delegate of a NavigationCoordinator’s rootViewController. -Instead use the delegate property of the NavigationCoordinator itself. - -
    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open class NavigationAnimationDelegate : NSObject
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - NavigationCoordinator - -
    -
    -
    -
    -
    -
    -

    NavigationCoordinator acts as a base class for custom coordinators with a UINavigationController -as rootViewController.

    - -

    NavigationCoordinator especially ensures that transition animations are called, -which would not be the case when creating a BaseCoordinator<RouteType, NavigationTransition>.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open class NavigationCoordinator<RouteType> : BaseCoordinator<RouteType, NavigationTransition> where RouteType : Route
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - PageCoordinator - -
    -
    -
    -
    -
    -
    -

    PageCoordinator provides a base class for your custom coordinator with a UIPageViewController rootViewController.

    -
    -

    Note

    - PageCoordinator sets the dataSource of the rootViewController to reflect the parameters in the initializer. - -
    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open class PageCoordinator<RouteType> : BaseCoordinator<RouteType, PageTransition> where RouteType : Route
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • - -
    -
    -
    -
    -
    -

    PageCoordinatorDataSource is a -UIPageViewControllerDataSource -implementation with a rather static list of pages.

    - -

    It further allows looping through the given pages. When looping is active the pages are wrapped around in the given presentables array. -When the user navigates beyond the end of the specified pages, the pages are wrapped around by displaying the first page. -In analogy to that, it also wraps to the last page when navigating beyond the beginning.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open class PageCoordinatorDataSource : NSObject, UIPageViewControllerDataSource
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - RedirectionRouter - -
    -
    -
    -
    -
    -
    -

    RedirectionRouters can be used to extract routes into different route types. -Instead of having one huge route and one or more huge coordinators, you can create separate redirecting routers.

    - -

    Create a RedirectionRouter from a parent router by providing a reference to that parent. -Triggered routes of the RedirectionRouter will be redirected to this parent router according to the provided mapping. -Please provide either a map closure in the initializer or override the mapToParentRoute method.

    - -

    A RedirectionRouter has a viewController which is used in transitions, -e.g. when you are presenting, pushing, or otherwise displaying it.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open class RedirectionRouter<ParentRoute, RouteType> : Router where ParentRoute : Route, RouteType : Route
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - SplitCoordinator - -
    -
    -
    -
    -
    -
    -

    SplitCoordinator can be used as a basis for a coordinator with a rootViewController of type -UISplitViewController.

    - -

    You can use all SplitTransitions and get an initializer to set a master and -(optional) detail presentable.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open class SplitCoordinator<RouteType> : BaseCoordinator<RouteType, SplitTransition> where RouteType : Route
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • - -
    -
    -
    -
    -
    -

    StaticTransitionAnimation can be used to realize static transition animations.

    -
    -

    Note

    - Consider using InteractiveTransitionAnimation instead, if possible, as it is as simple -to use. However, this class is helpful to make sure your transition animation is not mistaken to be -interactive, if your animation code does not fulfill the requirements of an interactive transition -animation. - -
    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open class StaticTransitionAnimation : NSObject, TransitionAnimation
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - StrongRouter - -
    -
    -
    -
    -
    -
    -

    StrongRouter is a type-erasure of a given Router object and, therefore, can be used as an abstraction from a specific Router -implementation without losing type information about its RouteType.

    - -

    StrongRouter abstracts away any implementation specific details and -essentially reduces them to properties specified in the Router protocol.

    -
    -

    Note

    - Do not hold a reference to any router from the view hierarchy. -Use UnownedRouter or WeakRouter in your view controllers or view models instead. -You can create them using the Coordinator.unownedRouter and Coordinator.weakRouter properties. - -
    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public final class StrongRouter<RouteType> : Router where RouteType : Route
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • - -
    -
    -
    -
    -
    -

    TabBarAnimationDelegate is used as the delegate of a TabBarCoordinator’s rootViewController -to allow for transitions to specify transition animations.

    - -

    TabBarAnimationDelegate conforms to the UITabBarControllerDelegate protocol -and is intended for use as the delegate of one tabbar controller only.

    -
    -

    Note

    - Do not override the delegate of a TabBarCoordinator’s rootViewController-delegate. -Instead use the delegate property of the TabBarCoordinator itself. - -
    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open class TabBarAnimationDelegate : NSObject
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - TabBarCoordinator - -
    -
    -
    -
    -
    -
    -

    Use a TabBarCoordinator to coordinate a flow where a UITabbarController serves as a rootViewController. -With a TabBarCoordinator, you get access to all tabbarController-related transitions.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open class TabBarCoordinator<RouteType> : BaseCoordinator<RouteType, TabBarTransition> where RouteType : Route
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - ViewCoordinator - -
    -
    -
    -
    -
    -
    -

    ViewCoordinator is a base class for custom coordinators with a UIViewController rootViewController.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open class ViewCoordinator<RouteType> : BaseCoordinator<RouteType, ViewTransition> where RouteType : Route
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Classes/Animation.html b/docs/Classes/Animation.html deleted file mode 100644 index 9950c0b3..00000000 --- a/docs/Classes/Animation.html +++ /dev/null @@ -1,698 +0,0 @@ - - - - Animation Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - Animation Class Reference -

- -
- -
- -
-
-

Animation

-
-
- 
open class Animation : NSObject
- -
-
-

Animation is used to set presentation and dismissal animations for presentables.

- -

Depending on the transition in use, different properties of a UIViewController are set to make sure the transition animation is used.

-
-

Note

-

To not override the previously set Animation, use nil when initializing a transition.

- -

Make sure to hold a strong reference to the Animation object, as it is only held by a weak reference.

- -
- -
-
- -
-
-
-
- - - -

Static properties

- -
-
    -
  • -
    - - - - default - -
    -
    -
    -
    -
    -
    -

    Use Animation.default to override currently set animations -and reset to the default animations provided by iOS

    -
    -

    Note

    - To disable animations make sure to use non-animating TransitionOptions when triggering. - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static let `default`: Animation
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Stored properties

- -
-
    -
  • -
    - - - - presentationAnimation - -
    -
    -
    -
    -
    -
    -

    The transition animation performed when transitioning to a presentable.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open var presentationAnimation: TransitionAnimation?
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - dismissalAnimation - -
    -
    -
    -
    -
    -
    -

    The transition animation performed when transitioning away from a presentable.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open var dismissalAnimation: TransitionAnimation?
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Initialization

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Creates an Animation object containing a presentation and a dismissal animation.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(presentation: TransitionAnimation?, dismissal: TransitionAnimation?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - presentation - - -
    -

    The transition animation performed when transitioning to a presentable.

    -
    -
    - - dismissal - - -
    -

    The transition animation performed when transitioning away from a presentable.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

UIViewControllerTransitioningDelegate

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    See UIViewControllerTransitioningDelegate -for further reference.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func animationController(forPresented presented: UIViewController,
-                              presenting: UIViewController,
-                              source: UIViewController) -> UIViewControllerAnimatedTransitioning?
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - presented - - -
    -

    The view controller to be presented.

    -
    -
    - - presenting - - -
    -

    The view controller that is presenting.

    -
    -
    - - source - - -
    -

    The view controller whose present(_:animated:completion:) was called.

    -
    -
    -
    -
    -

    Return Value

    -

    The presentation animation when initializing the Animation object.

    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UIViewControllerTransitioningDelegate -for further reference.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func animationController(forDismissed dismissed: UIViewController) -> UIViewControllerAnimatedTransitioning?
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - dismissed - - -
    -

    The view controller to be dismissed.

    -
    -
    -
    -
    -

    Return Value

    -

    The dismissal animation when initializing the Animation object.

    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UIViewControllerTransitioningDelegate -for further reference.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func interactionControllerForPresentation(using animator: UIViewControllerAnimatedTransitioning)
-    -> UIViewControllerInteractiveTransitioning?
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - animator - - -
    -

    The animator of this transition, which is most likely the presentation animation.

    -
    -
    -
    -
    -

    Return Value

    -

    The presentation animation’s interaction controller.

    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UIViewControllerTransitioningDelegate -for further reference.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func interactionControllerForDismissal(using animator: UIViewControllerAnimatedTransitioning)
-    -> UIViewControllerInteractiveTransitioning?
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - animator - - -
    -

    The animator of this transition, which is most likely the dismissal animation.

    -
    -
    -
    -
    -

    Return Value

    -

    The dismissal animation’s interaction controller.

    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Classes/AnyCoordinator.html b/docs/Classes/AnyCoordinator.html deleted file mode 100644 index 325ac30c..00000000 --- a/docs/Classes/AnyCoordinator.html +++ /dev/null @@ -1,616 +0,0 @@ - - - - AnyCoordinator Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - AnyCoordinator Class Reference -

- -
- -
- -
-
-

AnyCoordinator

-
-
- 
public class AnyCoordinator<RouteType, TransitionType> : Coordinator where RouteType : Route, TransitionType : TransitionProtocol
- -
-
-

AnyCoordinator is a type-erased Coordinator (RouteType & TransitionType) and -can be used as an abstraction from a specific coordinator class while still specifying -TransitionType and RouteType.

-
-

Note

- If you do not want/need to specify TransitionType, you might want to look into the -different router abstractions StrongRouter, UnownedRouter and WeakRouter. -See AnyTransitionPerformer to further abstract from RouteType. - -
- -
-
- -
-
-
-
- - - -

Initialization

- -
-
    -
  • -
    - - - - init(_:) - -
    -
    -
    -
    -
    -
    -

    Creates a type-erased Coordinator for a specific coordinator.

    - -

    A strong reference to the source coordinator is kept.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init<C>(_ coordinator: C) where RouteType == C.RouteType, TransitionType == C.TransitionType, C : Coordinator
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - coordinator - - -
    -

    The source coordinator.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Computed properties

- -
-
    -
  • -
    - - - - rootViewController - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var rootViewController: TransitionType.RootViewController { get }
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - viewController - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var viewController: UIViewController! { get }
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Methods

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Prepare and return transitions for a given route.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func prepareTransition(for route: RouteType) -> TransitionType
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - route - - -
    -

    The triggered route for which a transition is to be prepared.

    -
    -
    -
    -
    -

    Return Value

    -

    The prepared transition.

    -
    -
    -
    -
    • -
  • -
    - - - - presented(from:) - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func presented(from presentable: Presentable?)
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - registerParent(_:) - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func registerParent(_ presentable: Presentable & AnyObject)
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - setRoot(for:) - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func setRoot(for window: UIWindow)
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - addChild(_:) - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func addChild(_ presentable: Presentable)
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - removeChild(_:) - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func removeChild(_ presentable: Presentable)
    - -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func removeChildrenIfNeeded()
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Classes/AnyTransitionPerformer.html b/docs/Classes/AnyTransitionPerformer.html deleted file mode 100644 index 2cf62098..00000000 --- a/docs/Classes/AnyTransitionPerformer.html +++ /dev/null @@ -1,401 +0,0 @@ - - - - AnyTransitionPerformer Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - AnyTransitionPerformer Class Reference -

- -
- -
- -
-
-

AnyTransitionPerformer

-
-
- 
public class AnyTransitionPerformer<TransitionType> : TransitionPerformer where TransitionType : TransitionProtocol
- -
-
-

AnyTransitionPerformer can be used as an abstraction from a specific TransitionPerformer implementation -without losing type information about its TransitionType.

- -

This type abstraction can be especially helpful when performing transitions. -AnyTransitionPerformer abstracts away any implementation specific details and reduces coordinators to the capabilities -of the TransitionPerformer protocol.

- -
-
- -
-
-
-
- - - -

Computed properties

- -
-
    -
  • -
    - - - - viewController - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var viewController: UIViewController! { get }
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - rootViewController - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var rootViewController: TransitionType.RootViewController { get }
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Methods

- -
- -
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Classes/BaseCoordinator.html b/docs/Classes/BaseCoordinator.html deleted file mode 100644 index a6b17b78..00000000 --- a/docs/Classes/BaseCoordinator.html +++ /dev/null @@ -1,1007 +0,0 @@ - - - - BaseCoordinator Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - BaseCoordinator Class Reference -

- -
- -
- -
-
-

BaseCoordinator

-
-
- 
open class BaseCoordinator<RouteType, TransitionType> : Coordinator where RouteType : Route, TransitionType : TransitionProtocol
- -
-
-

BaseCoordinator can (and is encouraged to) be used as a superclass for any custom implementation of a coordinator.

- -

It is also encouraged to use already provided subclasses of BaseCoordinator such as -NavigationCoordinator, TabBarCoordinator, ViewCoordinator, SplitCoordinator -and PageCoordinator.

- -
-
- -
-
-
-
- - - -

Stored properties

- -
-
    -
  • -
    - - - - children - -
    -
    -
    -
    -
    -
    -

    The child coordinators that are currently in the view hierarchy. -When performing a transition, children are automatically added and removed from this array -depending on whether they are in the view hierarchy.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public private(set) var children: [Presentable]
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Computed properties

- -
-
    -
  • -
    - - - - rootViewController - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public private(set) var rootViewController: RootViewController
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - viewController - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var viewController: UIViewController! { get }
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Initialization

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    This initializer trigger a route before the coordinator is made visible.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(rootViewController: RootViewController, initialRoute: RouteType?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - initialRoute - - -
    -

    If a route is specified, it is triggered before making the coordinator visible.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    This initializer performs a transition before the coordinator is made visible.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(rootViewController: RootViewController, initialTransition: TransitionType?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - initialTransition - - -
    -

    If a transition is specified, it is performed before making the coordinator visible.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Open methods

- -
-
    -
  • -
    - - - - presented(from:) - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func presented(from presentable: Presentable?)
    - -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func removeChildrenIfNeeded()
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - addChild(_:) - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func addChild(_ presentable: Presentable)
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - removeChild(_:) - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func removeChild(_ presentable: Presentable)
    - -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    This method prepares transitions for routes. -Override this method to define transitions for triggered routes.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func prepareTransition(for route: RouteType) -> TransitionType
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - route - - -
    -

    The triggered route for which a transition is to be prepared.

    -
    -
    -
    -
    -

    Return Value

    -

    The prepared transition.

    -
    -
    -
    -
    • -
  • -
    - - - - registerParent(_:) - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func registerParent(_ presentable: Presentable & AnyObject)
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - RootViewController - -
    -
    -
    -
    -
    -
    -

    Shortcut for BaseCoordinator.TransitionType.RootViewController

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public typealias RootViewController = TransitionType.RootViewController
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Registering

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Register an interactive transition triggered by a gesture recognizer.

    - -

    Also consider registerInteractiveTransition(for:triggeredBy:progress:shouldFinish:completion:) as it might make it easier -to implement an interactive transition. This is meant for cases where the other method does not provide enough customization -options.

    - -

    A target is added to the gestureRecognizer so that the handler is executed every time the state of the gesture recognizer changes.

    -
    -

    Note

    -

    Use unregisterInteractiveTransition(triggeredBy:) to remove previously added interactive transitions.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func registerInteractiveTransition<GestureRecognizer: UIGestureRecognizer>(
-    for route: RouteType,
-    triggeredBy recognizer: GestureRecognizer,
-    handler: @escaping (_ handlerRecognizer: GestureRecognizer, _ transition: () -> TransitionAnimation?) -> Void,
-    completion: PresentationHandler? = nil)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - route - - -
    -

    The route to be triggered when the gestureRecognizer begins. -Make sure that the transition behind is interactive as otherwise the transition is simply performed.

    -
    -
    - - recognizer - - -
    -

    The gesture recognizer to be used to update the interactive transition.

    -
    -
    - - handler - - -
    -

    The handler to update the interaction controller of the animation generated by the given transition closure.

    -
    -
    - - handlerRecognizer - - -
    -

    The gestureRecognizer with which the handler has been registered.

    -
    -
    - - transition - - -
    -

    The closure to perform the transition. It returns the transition animation to control the interaction controller of. -TransitionAnimation.start() is automatically called.

    -
    -
    - - completion - - -
    -

    The closure to be called whenever the transition completes. -Hint: Might be called multiple times but only once per performing the transition.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Register an interactive transition triggered by a gesture recognizer.

    - -

    To get more customization options, check out registerInteractiveTransition(for:triggeredBy:handler:completion:).

    - -

    A target is added to the gestureRecognizer so that the handler is executed every time the state of the gesture recognizer changes.

    -
    -

    Note

    -

    Use unregisterInteractiveTransition(triggeredBy:) to remove previously added interactive transitions.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func registerInteractiveTransition<GestureRecognizer: UIGestureRecognizer>(
-    for route: RouteType,
-    triggeredBy recognizer: GestureRecognizer,
-    progress: @escaping (GestureRecognizer) -> CGFloat,
-    shouldFinish: @escaping (GestureRecognizer) -> Bool,
-    completion: PresentationHandler? = nil)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - - - - - - - - - -
    - - route - - -
    -

    The route to be triggered when the gestureRecognizer begins. -Make sure that the transition behind is interactive as otherwise the transition is simply performed.

    -
    -
    - - recognizer - - -
    -

    The gesture recognizer to be used to update the interactive transition.

    -
    -
    - - progress - - -
    -

    Return the progress as CGFloat between 0 (start) and 1 (finish).

    -
    -
    - - shouldFinish - - -
    -

    Decide depending on the gestureRecognizer’s state whether to finish or cancel a given transition.

    -
    -
    - - completion - - -
    -

    The closure to be called whenever the transition completes. -Hint: Might be called multiple times but only once per performing the transition.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Unregistering

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Unregisters a previously registered interactive transition.

    - -

    Unregistering is not mandatory to prevent reference cycles, etc. -It is useful, though, to remove previously registered interactive transitions that are no longer needed or wanted.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func unregisterInteractiveTransitions(triggeredBy recognizer: UIGestureRecognizer)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - recognizer - - -
    -

    The recognizer to unregister interactive transitions for. -This method will unregister all interactive transitions with that gesture recognizer.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Classes/BasicCoordinator.html b/docs/Classes/BasicCoordinator.html deleted file mode 100644 index 56246807..00000000 --- a/docs/Classes/BasicCoordinator.html +++ /dev/null @@ -1,487 +0,0 @@ - - - - BasicCoordinator Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - BasicCoordinator Class Reference -

- -
- -
- -
-
-

BasicCoordinator

-
-
- 
open class BasicCoordinator<RouteType, TransitionType> : BaseCoordinator<RouteType, TransitionType> where RouteType : Route, TransitionType : TransitionProtocol
- -
-
-

BasicCoordinator is a coordinator class that can be used without subclassing.

- -

Although subclassing of coordinators is encouraged for more complex cases, a BasicCoordinator can easily -be created by only providing a prepareTransition closure, an initialRoute and an initialLoadingType.

- -
-
- -
-
-
-
- - - -

Nested types

- -
-
    -
  • -
    - - - - InitialLoadingType - -
    -
    -
    -
    -
    -
    -

    InitialLoadingType differentiates between different points in time when the initital route is to -be triggered by the coordinator.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public enum InitialLoadingType
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Initialization

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Creates a BasicCoordinator.

    -
    -

    Seealso

    -

    See InitialLoadingType for more information.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(rootViewController: RootViewController,
-            initialRoute: RouteType? = nil,
-            initialLoadingType: InitialLoadingType = .presented,
-            prepareTransition: ((RouteType) -> TransitionType)?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - initialRoute - - -
    -

    If a route is specified, it is triggered depending on the initialLoadingType.

    -
    -
    - - initialLoadingType - - -
    -

    The initialLoadingType specifies when the initialRoute is triggered.

    -
    -
    - - prepareTransition - - -
    -

    A closure to define transitions based on triggered routes. -Make sure to override prepareTransition by subclassing, if you specify nil here.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Open methods

- -
-
    -
  • -
    - - - - presented(from:) - -
    -
    -
    -
    -
    -
    -

    This method is called whenever the BasicCoordinator is shown to the user.

    - -

    If initialLoadingType has been specified as presented and an initialRoute is present, -the route is triggered here.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open override func presented(from presentable: Presentable?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - presentable - - -
    -

    The context in which this coordinator has been shown to the user.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open override func prepareTransition(for route: RouteType) -> TransitionType
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Classes/BasicCoordinator/InitialLoadingType.html b/docs/Classes/BasicCoordinator/InitialLoadingType.html deleted file mode 100644 index b25611d2..00000000 --- a/docs/Classes/BasicCoordinator/InitialLoadingType.html +++ /dev/null @@ -1,327 +0,0 @@ - - - - InitialLoadingType Enumeration Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - InitialLoadingType Enumeration Reference -

- -
- -
- -
-
-

InitialLoadingType

-
-
- 
public enum InitialLoadingType
- -
-
-

InitialLoadingType differentiates between different points in time when the initital route is to -be triggered by the coordinator.

- -
-
- -
-
-
-
    -
  • -
    - - - - immediately - -
    -
    -
    -
    -
    -
    -

    The initial route is triggered before the coordinator is made visible (i.e. on initialization).

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    case immediately
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - presented - -
    -
    -
    -
    -
    -
    -

    The initial route is triggered after the coordinator is made visible.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    case presented
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Classes/InteractiveTransitionAnimation.html b/docs/Classes/InteractiveTransitionAnimation.html deleted file mode 100644 index 4df724ac..00000000 --- a/docs/Classes/InteractiveTransitionAnimation.html +++ /dev/null @@ -1,735 +0,0 @@ - - - - InteractiveTransitionAnimation Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - InteractiveTransitionAnimation Class Reference -

- -
- -
- -
-
-

InteractiveTransitionAnimation

-
-
- 
open class InteractiveTransitionAnimation : NSObject, TransitionAnimation
- -
-
-

InteractiveTransitionAnimation provides a simple interface to create interactive transition animations.

- -

An InteractiveTransitionAnimation can be created by providing the duration, the animation code -and (optionally) a closure to create an interaction controller.

-
-

Note

- To get further information read the UIKit documentation of -UIViewControllerAnimatedTransitioning, -UIViewControllerInteractiveTransitioning, -UIViewControllerContextTransitioning and -UIPercentDrivenInteractiveTransition. - -
- -
-
- -
-
-
-
- - - -

Computed properties

- -
- -
-
-
- - - -

Initialization

- -
- -
-
-
- - - -

Methods

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    See UIViewControllerAnimatedTransitioning -for further information.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func transitionDuration(using transitionContext: UIViewControllerContextTransitioning?) -> TimeInterval
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - transitionContext - - -
    -

    The context of the transition.

    -
    -
    -
    -
    -

    Return Value

    -

    The transition duration as specified in the initializer.

    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UIViewControllerAnimatedTransitioning -for further information.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func animateTransition(using transitionContext: UIViewControllerContextTransitioning)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - transitionContext - - -
    -

    The context of a transition for which the animation should be started.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

TransitionAnimation

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    This method is used to generate an applicable interaction controller.

    -
    -

    Note

    - To allow for more complex logic to create a specific interaction controller, -override this method in your subclass. - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func generateInteractionController() -> PercentDrivenInteractionController?
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - start() - -
    -
    -
    -
    -
    -
    -

    Starts the transition animation by generating an interaction controller.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func start()
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - cleanup() - -
    -
    -
    -
    -
    -
    -

    Ends the transition animation by deleting the interaction controller.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func cleanup()
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Classes/InterruptibleTransitionAnimation.html b/docs/Classes/InterruptibleTransitionAnimation.html deleted file mode 100644 index 19f3c114..00000000 --- a/docs/Classes/InterruptibleTransitionAnimation.html +++ /dev/null @@ -1,589 +0,0 @@ - - - - InterruptibleTransitionAnimation Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - InterruptibleTransitionAnimation Class Reference -

- -
- -
- -
-
-

InterruptibleTransitionAnimation

-
-
- 
@available(iOS 10.0, *)
-open class InterruptibleTransitionAnimation : InteractiveTransitionAnimation
- -
-
-

Use InterruptibleTransitionAnimation to define interactive transitions based on the -UIViewPropertyAnimator -APIs introduced in iOS 10.

- -
-
- -
-
-
-
- - - -

Initialization

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Creates an interruptible transition animation based on duration, an animator generator closure -and an interaction controller generator closure.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(duration: TimeInterval,
-            generateAnimator: @escaping (UIViewControllerContextTransitioning) -> UIViewImplicitlyAnimating,
-            generateInteractionController: @escaping () -> PercentDrivenInteractionController?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - duration - - -
    -

    The total duration of the animation.

    -
    -
    - - generateAnimator - - -
    -

    A generator closure to create a UIViewPropertyAnimator dynamically.

    -
    -
    - - generateInteractionController - - -
    -

    A generator closure to create an interaction controller which handles animation progress changes.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Creates an interruptible transition animation based on duration and an animator generator closure.

    - -

    A UIPercentDrivenInteractiveTransition is used as interaction controller.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public convenience init(duration: TimeInterval,
-                        generateAnimator: @escaping (UIViewControllerContextTransitioning) -> UIViewImplicitlyAnimating)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - duration - - -
    -

    The total duration of the animation.

    -
    -
    - - generateAnimator - - -
    -

    A generator closure to create a UIViewPropertyAnimator dynamically.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Methods

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Generates an interruptible animator based on the transitionContext. -It further adds a completion block to the animator to ensure it is deallocated once -the transition is finished.

    - -

    This code is called once per transition to generate the interruptible animator -which is reused in subsequent calls of interruptibeAnimator(using:).

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func generateInterruptibleAnimator(using transitionContext: UIViewControllerContextTransitioning) -> UIViewImplicitlyAnimating
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - transitionContext - - -
    -

    The context in which the transition is performed.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

TransitionAnimation

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    See UIViewControllerAnimatedTransitioning -for further information.

    - -

    This method simply calls startAnimation() on the interruptible animator.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open override func animateTransition(using transitionContext: UIViewControllerContextTransitioning)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - transitionContext - - -
    -

    The context in which the transition is performed.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UIViewControllerAnimatedTransitioning -for further information.

    - -

    This method returns an already generated interruptible animator, if present. -Otherwise it generates a new one using generateInterruptibleAnimator(using:).

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func interruptibleAnimator(using transitionContext: UIViewControllerContextTransitioning
-    ) -> UIViewImplicitlyAnimating
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - transitionContext - - -
    -

    The context in which the transition is performed.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Classes/NavigationAnimationDelegate.html b/docs/Classes/NavigationAnimationDelegate.html deleted file mode 100644 index 88d98297..00000000 --- a/docs/Classes/NavigationAnimationDelegate.html +++ /dev/null @@ -1,855 +0,0 @@ - - - - NavigationAnimationDelegate Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - NavigationAnimationDelegate Class Reference -

- -
- -
- -
-
-

NavigationAnimationDelegate

-
-
- 
open class NavigationAnimationDelegate : NSObject
- -
-
-

NavigationAnimationDelegate is used as the delegate of a NavigationCoordinator’s rootViewController -to allow for push-transitions to specify animations.

- -

NavigationAnimationDelegate conforms to the UINavigationControllerDelegate protocol -and is intended for use as the delegate of one navigation controller only.

-
-

Note

- Do not override the delegate of a NavigationCoordinator’s rootViewController. -Instead use the delegate property of the NavigationCoordinator itself. - -
- -
-
- -
-
-
-
- - - -

Stored properties

- -
-
    -
  • -
    - - - - velocityThreshold - -
    -
    -
    -
    -
    -
    -

    The velocity threshold needed for the interactive pop transition to succeed

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open var velocityThreshold: CGFloat { get }
    - -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    The transition progress threshold for the interactive pop transition to succeed

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open var transitionProgressThreshold: CGFloat { get }
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

UINavigationControllerDelegate

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    See UINavigationControllerDelegate documentation -for further reference.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func navigationController(_ navigationController: UINavigationController,
-                               interactionControllerFor animationController: UIViewControllerAnimatedTransitioning
-    ) -> UIViewControllerInteractiveTransitioning?
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - navigationController - - -
    -

    The delegate owner.

    -
    -
    - - animationController - - -
    -

    The animationController to return the interactionController for.

    -
    -
    -
    -
    -

    Return Value

    -

    If the animationController is a TransitionAnimation, it returns its interactionController. -Otherwise it requests an interactionController from the NavigationCoordinator’s delegate.

    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UINavigationControllerDelegate documentation -for further reference.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func navigationController(_ navigationController: UINavigationController,
-                               animationControllerFor operation: UINavigationController.Operation,
-                               from fromVC: UIViewController,
-                               to toVC: UIViewController) -> UIViewControllerAnimatedTransitioning?
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - - - - - -
    - - navigationController - - -
    -

    The delegate owner.

    -
    -
    - - operation - - -
    -

    The operation being executed. Possible values are push, pop or none.

    -
    -
    - - fromVC - - -
    -

    The source view controller of the transition.

    -
    -
    - - toVC - - -
    -

    The destination view controller of the transition.

    -
    -
    -
    -
    -

    Return Value

    -

    The destination view controller’s animationController depending on its transitioningDelegate. -In the case of a push operation, it returns the toVC’s presentation animation. -For pop it is the fromVC’s dismissal animation. If there is no transitioningDelegate or the operation none is used, -it uses the NavigationCoordinator’s delegate as fallback.

    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UINavigationControllerDelegate documentation -for further reference.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func navigationController(_ navigationController: UINavigationController,
-                               didShow viewController: UIViewController, animated: Bool)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - navigationController - - -
    -

    The delegate owner.

    -
    -
    - - operation - - -
    -

    The operation being executed. Possible values are push, pop or none.

    -
    -
    - - viewController - - -
    -

    The target view controller.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UINavigationControllerDelegate documentation -for further reference.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func navigationController(_ navigationController: UINavigationController,
-                               willShow viewController: UIViewController,
-                               animated: Bool)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - navigationController - - -
    -

    The delegate owner.

    -
    -
    - - operation - - -
    -

    The operation being executed. Possible values are push, pop or none.

    -
    -
    - - viewController - - -
    -

    The view controller to be shown.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Delegate methods

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    See UIGestureRecognizerDelegate documentation -for further reference.

    -
    -

    Note

    -

    This method alters the target of the gestureRecognizer to either its former delegate (UIKit default) -or this class depending on whether a pop animation has been specified.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func gestureRecognizerShouldBegin(_ gestureRecognizer: UIGestureRecognizer) -> Bool
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - gestureRecognizer - - -
    -

    The gesture recognizer this class is the delegate of. -This class is used as the delegate for the interactivePopGestureRecognizer of -the navigationController.

    -
    -
    -
    -
    -

    Return Value

    -

    This method returns true, if and only if

    - -
      -
    • there are more than 1 view controllers on the navigation controller stack (so that it is possible to pop a viewController) and
      • -
    • it is the interactivePopGestureRecognizer to call this method
      • -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Target actions

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    This method handles changes of the navigation controller’s interactivePopGestureRecognizer.

    - -

    This method performs the top-most dismissalAnimation and informs its interaction controller about changes -of the interactivePopGestureRecognizer’s state.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    @objc
-open func handleInteractivePopGestureRecognizer(_ gestureRecognizer: UIGestureRecognizer)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - gestureRecognizer - - -
    -

    The interactivePopGestureRecognizer of the UINavigationController.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Helpers

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    This method sets up the interactivePopGestureRecognizer of the navigation controller -to allow for custom interactive pop animations.

    - -

    This method overrides the delegate of the interactivePopGestureRecognizer to self, -but keeps a reference to the original delegate to enable the default pop animations.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func setupPopGestureRecognizer(for navigationController: UINavigationController)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - navigationController - - -
    -

    The navigation controller to be set up.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Classes/NavigationCoordinator.html b/docs/Classes/NavigationCoordinator.html deleted file mode 100644 index 7ff05792..00000000 --- a/docs/Classes/NavigationCoordinator.html +++ /dev/null @@ -1,458 +0,0 @@ - - - - NavigationCoordinator Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - NavigationCoordinator Class Reference -

- -
- -
- -
-
-

NavigationCoordinator

-
-
- 
open class NavigationCoordinator<RouteType> : BaseCoordinator<RouteType, NavigationTransition> where RouteType : Route
- -
-
-

NavigationCoordinator acts as a base class for custom coordinators with a UINavigationController -as rootViewController.

- -

NavigationCoordinator especially ensures that transition animations are called, -which would not be the case when creating a BaseCoordinator<RouteType, NavigationTransition>.

- -
-
- -
-
-
-
- - - -

Stored properties

- -
-
    -
  • -
    - - - - animationDelegate - -
    -
    -
    -
    -
    -
    -

    The animation delegate controlling the rootViewController’s transition animations. -This animation delegate is set to be the rootViewController’s rootViewController, if you did not set one earlier.

    -
    -

    Note

    - Use the delegate property to set a custom delegate and use transition animations provided by XCoordinator. - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public let animationDelegate: NavigationAnimationDelegate
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Computed properties

- -
-
    -
  • -
    - - - - delegate - -
    -
    -
    -
    -
    -
    -

    This represents a fallback-delegate to be notified about navigation controller events. -It is further used to call animation methods when no animation has been specified in the transition.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var delegate: UINavigationControllerDelegate? { get set }
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Initialization

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Creates a NavigationCoordinator and optionally triggers an initial route.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public override init(rootViewController: RootViewController = .init(), initialRoute: RouteType? = nil)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - initialRoute - - -
    -

    The route to be triggered.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Creates a NavigationCoordinator and pushes a presentable onto the navigation stack right away.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(rootViewController: RootViewController = .init(), root: Presentable)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - root - - -
    -

    The presentable to be pushed.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Classes/PageCoordinator.html b/docs/Classes/PageCoordinator.html deleted file mode 100644 index 16b56db4..00000000 --- a/docs/Classes/PageCoordinator.html +++ /dev/null @@ -1,525 +0,0 @@ - - - - PageCoordinator Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - PageCoordinator Class Reference -

- -
- -
- -
-
-

PageCoordinator

-
-
- 
open class PageCoordinator<RouteType> : BaseCoordinator<RouteType, PageTransition> where RouteType : Route
- -
-
-

PageCoordinator provides a base class for your custom coordinator with a UIPageViewController rootViewController.

-
-

Note

- PageCoordinator sets the dataSource of the rootViewController to reflect the parameters in the initializer. - -
- -
-
- -
-
-
-
- - - -

Stored properties

- -
-
    -
  • -
    - - - - dataSource - -
    -
    -
    -
    -
    -
    -

    The dataSource of the rootViewController.

    - -

    Feel free to change the pages at runtime. To reflect the changes in the rootViewController, perform a set transition as well.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public let dataSource: UIPageViewControllerDataSource
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Initialization

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Creates a PageCoordinator with several sequential (potentially looping) pages.

    - -

    It further sets the current page of the rootViewController animated in the specified direction.

    -
    -

    Note

    -

    If you need custom configuration of the rootViewController, modify the configuration parameter, -since you cannot change this after the initialization.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(rootViewController: RootViewController = .init(),
-            pages: [Presentable],
-            loop: Bool = false,
-            set: Presentable? = nil,
-            direction: UIPageViewController.NavigationDirection = .forward)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - - - - - - - - - -
    - - pages - - -
    -

    The pages of the PageCoordinator. -These can be changed later, if necessary, using the PageCoordinator.dataSource property.

    -
    -
    - - loop - - -
    -

    Whether or not the PageCoordinator should loop when hitting the end or the beginning of the specified pages.

    -
    -
    - - set - - -
    -

    The presentable to be shown right from the start. -This should be one of the elements of the specified pages. -If not specified, no set transition is triggered, which results in the first page being shown.

    -
    -
    - - direction - - -
    -

    The direction in which the transition to set the specified first page (parameter set) should be animated in. -If you specify nil for set, this parameter is ignored.

    -
    -
    - - configuration - - -
    -

    The configuration of the rootViewController. You cannot change this configuration later anymore (Limitation of UIKit).

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Creates a PageCoordinator with a custom dataSource. -It further sets the currently shown page and a direction for the animation of displaying it. -If you need custom configuration of the rootViewController, modify the configuration parameter, -since you cannot change this after the initialization.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(rootViewController: RootViewController = .init(),
-            dataSource: UIPageViewControllerDataSource,
-            set: Presentable,
-            direction: UIPageViewController.NavigationDirection)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - - - - - -
    - - dataSource - - -
    -

    The dataSource of the PageCoordinator.

    -
    -
    - - set - - -
    -

    The presentable to be shown right from the start. -This should be one of the elements of the specified pages. -If not specified, no set transition is triggered, which results in the first page being shown.

    -
    -
    - - direction - - -
    -

    The direction in which the transition to set the specified first page (parameter set) should be animated in. -If you specify nil for set, this parameter is ignored.

    -
    -
    - - configuration - - -
    -

    The configuration of the rootViewController. You cannot change this configuration later anymore (Limitation of UIKit).

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Classes/PageCoordinatorDataSource.html b/docs/Classes/PageCoordinatorDataSource.html deleted file mode 100644 index e6e8c8c3..00000000 --- a/docs/Classes/PageCoordinatorDataSource.html +++ /dev/null @@ -1,660 +0,0 @@ - - - - PageCoordinatorDataSource Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - PageCoordinatorDataSource Class Reference -

- -
- -
- -
-
-

PageCoordinatorDataSource

-
-
- 
open class PageCoordinatorDataSource : NSObject, UIPageViewControllerDataSource
- -
-
-

PageCoordinatorDataSource is a -UIPageViewControllerDataSource -implementation with a rather static list of pages.

- -

It further allows looping through the given pages. When looping is active the pages are wrapped around in the given presentables array. -When the user navigates beyond the end of the specified pages, the pages are wrapped around by displaying the first page. -In analogy to that, it also wraps to the last page when navigating beyond the beginning.

- -
-
- -
-
-
-
- - - -

Stored properties

- -
-
    -
  • -
    - - - - pages - -
    -
    -
    -
    -
    -
    -

    The pages of the UIPageViewController in sequential order.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open var pages: [UIViewController]
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - loop - -
    -
    -
    -
    -
    -
    -

    Whether or not the pages of the UIPageViewController should be in a loop, -i.e. whether a swipe to the left of the last page should result in the first page being shown -(or the last shown when swiping right on the first page)

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open var loop: Bool
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Initialization

- -
-
    -
  • -
    - - - - init(pages:loop:) - -
    -
    -
    -
    -
    -
    -

    Creates a PageCoordinatorDataSource with the given pages and looping capabilities.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(pages: [UIViewController], loop: Bool)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - pages - - -
    -

    The pages to be shown in the UIPageViewController.

    -
    -
    - - loop - - -
    -

    Whether or not the pages of the UIPageViewController should be in a loop, -i.e. whether a swipe to the left of the last page should result in the first page being shown -(or the last shown when swiping right on the first page) -If you specify false here, the user cannot swipe left on the last page and right on the first.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Methods

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    See UIPageViewControllerDataSource -for further information.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func presentationCount(for pageViewController: UIPageViewController) -> Int
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - pageViewController - - -
    -

    The dataSource owner.

    -
    -
    -
    -
    -

    Return Value

    -

    The count of pages, if it is displayed. Otherwise 0.

    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UIPageViewControllerDataSource -for further information.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func presentationIndex(for pageViewController: UIPageViewController) -> Int
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - pageViewController - - -
    -

    The dataSource owner.

    -
    -
    -
    -
    -

    Return Value

    -

    The index of the currently visible view controller.

    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UIPageViewControllerDataSource -for further information.

    - -

    This method first searches for the index of the given viewController in the pages array. -It then tries to find a viewController at the preceding position by potentially looping.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func pageViewController(_ pageViewController: UIPageViewController,
-                             viewControllerBefore viewController: UIViewController) -> UIViewController?
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - pageViewController - - -
    -

    The dataSource owner.

    -
    -
    - - viewController - - -
    -

    The viewController to find the preceding viewController of.

    -
    -
    -
    -
    -

    Return Value

    -

    The preceding viewController.

    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UIPageViewControllerDataSource -for further information.

    - -

    This method first searches for the index of the given viewController in the pages array. -It then tries to find a viewController at the following position by potentially looping.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func pageViewController(_ pageViewController: UIPageViewController,
-                             viewControllerAfter viewController: UIViewController) -> UIViewController?
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - pageViewController - - -
    -

    The dataSource owner.

    -
    -
    - - viewController - - -
    -

    The viewController to find the following viewController of.

    -
    -
    -
    -
    -

    Return Value

    -

    The following viewController.

    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Classes/RedirectionRouter.html b/docs/Classes/RedirectionRouter.html deleted file mode 100644 index 4685534c..00000000 --- a/docs/Classes/RedirectionRouter.html +++ /dev/null @@ -1,535 +0,0 @@ - - - - RedirectionRouter Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - RedirectionRouter Class Reference -

- -
- -
- -
-
-

RedirectionRouter

-
-
- 
open class RedirectionRouter<ParentRoute, RouteType> : Router where ParentRoute : Route, RouteType : Route
- -
-
-

RedirectionRouters can be used to extract routes into different route types. -Instead of having one huge route and one or more huge coordinators, you can create separate redirecting routers.

- -

Create a RedirectionRouter from a parent router by providing a reference to that parent. -Triggered routes of the RedirectionRouter will be redirected to this parent router according to the provided mapping. -Please provide either a map closure in the initializer or override the mapToParentRoute method.

- -

A RedirectionRouter has a viewController which is used in transitions, -e.g. when you are presenting, pushing, or otherwise displaying it.

- -
-
- -
-
-
-
- - - -

Stored properties

- -
-
    -
  • -
    - - - - parent - -
    -
    -
    -
    -
    -
    -

    A type-erased Router object of the parent router.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public let parent: UnownedRouter<ParentRoute>
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Computed properties

- -
-
    -
  • -
    - - - - viewController - -
    -
    -
    -
    -
    -
    -

    The viewController used in transitions, e.g. when pushing, presenting -or otherwise displaying the RedirectionRouter.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public private(set) var viewController: UIViewController!
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Initialization

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Creates a RedirectionRouter with a certain viewController, a parent router -and an optional mapping.

    -
    -

    Note

    -

    Make sure to either override mapToSuperRoute or to specify a closure for the map parameter. -If you override mapToSuperRoute, the map parameter is ignored.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(viewController: UIViewController,
-            parent: UnownedRouter<ParentRoute>,
-            map: ((RouteType) -> ParentRoute)?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - viewController - - -
    -

    The view controller to be used in transitions, e.g. when pushing, presenting or otherwise displaying the RedirectionRouter.

    -
    -
    - - parent - - -
    -

    Triggered routes will be rerouted to the parent router.

    -
    -
    - - map - - -
    -

    A mapping from this RedirectionRouter’s routes to the parent’s routes.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Methods

- -
-
    -
  • - -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func contextTrigger(_ route: RouteType,
-                         with options: TransitionOptions,
-                         completion: ContextPresentationHandler?)
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - mapToParentRoute(_:) - -
    -
    -
    -
    -
    -
    -

    Map RouteType to ParentRoute.

    - -

    This method is called when a route is triggered in the RedirectionRouter. -It is used to translate RouteType routes to the parent’s routes which are then triggered in the parent router.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func mapToParentRoute(_ route: RouteType) -> ParentRoute
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - route - - -
    -

    The route to be mapped.

    -
    -
    -
    -
    -

    Return Value

    -

    The mapped route for the parent router.

    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Classes/SplitCoordinator.html b/docs/Classes/SplitCoordinator.html deleted file mode 100644 index d688c8f3..00000000 --- a/docs/Classes/SplitCoordinator.html +++ /dev/null @@ -1,369 +0,0 @@ - - - - SplitCoordinator Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - SplitCoordinator Class Reference -

- -
- -
- -
-
-

SplitCoordinator

-
-
- 
open class SplitCoordinator<RouteType> : BaseCoordinator<RouteType, SplitTransition> where RouteType : Route
- -
-
-

SplitCoordinator can be used as a basis for a coordinator with a rootViewController of type -UISplitViewController.

- -

You can use all SplitTransitions and get an initializer to set a master and -(optional) detail presentable.

- -
-
- -
-
-
-
- - - -

Initialization

- -
-
    -
  • - -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public override init(rootViewController: RootViewController = .init(), initialRoute: RouteType?)
    - -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Creates a SplitCoordinator and sets the specified presentables as the rootViewController’s -viewControllers.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(rootViewController: RootViewController = .init(), master: Presentable, detail: Presentable?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - master - - -
    -

    The presentable to be shown as master in the UISplitViewController.

    -
    -
    - - detail - - -
    -

    The presentable to be shown as detail in the UISplitViewController. This is optional due to -the fact that it might not be useful to have a detail page right away on a small-screen device.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Classes/StaticTransitionAnimation.html b/docs/Classes/StaticTransitionAnimation.html deleted file mode 100644 index c0a8e4dc..00000000 --- a/docs/Classes/StaticTransitionAnimation.html +++ /dev/null @@ -1,526 +0,0 @@ - - - - StaticTransitionAnimation Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - StaticTransitionAnimation Class Reference -

- -
- -
- -
-
-

StaticTransitionAnimation

-
-
- 
open class StaticTransitionAnimation : NSObject, TransitionAnimation
- -
-
-

StaticTransitionAnimation can be used to realize static transition animations.

-
-

Note

- Consider using InteractiveTransitionAnimation instead, if possible, as it is as simple -to use. However, this class is helpful to make sure your transition animation is not mistaken to be -interactive, if your animation code does not fulfill the requirements of an interactive transition -animation. - -
- -
-
- -
-
-
-
- - - -

Computed properties

- -
- -
-
-
- - - -

Initialization

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Creates a StaticTransitionAnimation to be used as presentation or dismissal transition animation in -an Animation object.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(duration: TimeInterval, performAnimation: @escaping (_ context: UIViewControllerContextTransitioning) -> Void)
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Methods

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    See UIViewControllerAnimatedTransitioning -for further information.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func transitionDuration(using transitionContext: UIViewControllerContextTransitioning?) -> TimeInterval
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - transitionContext - - -
    -

    The context of the current transition.

    -
    -
    -
    -
    -

    Return Value

    -

    The duration of the animation as specified in the initializer.

    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UIViewControllerAnimatedTransitioning -for further information.

    - -

    This method performs the animation as specified in the initializer.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func animateTransition(using transitionContext: UIViewControllerContextTransitioning)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - transitionContext - - -
    -

    The context of the current transition.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

TransitionAnimation

- -
-
    -
  • -
    - - - - start() - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func start()
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - cleanup() - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func cleanup()
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Classes/StrongRouter.html b/docs/Classes/StrongRouter.html deleted file mode 100644 index 51bd8daf..00000000 --- a/docs/Classes/StrongRouter.html +++ /dev/null @@ -1,625 +0,0 @@ - - - - StrongRouter Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - StrongRouter Class Reference -

- -
- -
- -
-
-

StrongRouter

-
-
- 
public final class StrongRouter<RouteType> : Router where RouteType : Route
- -
-
-

StrongRouter is a type-erasure of a given Router object and, therefore, can be used as an abstraction from a specific Router -implementation without losing type information about its RouteType.

- -

StrongRouter abstracts away any implementation specific details and -essentially reduces them to properties specified in the Router protocol.

-
-

Note

- Do not hold a reference to any router from the view hierarchy. -Use UnownedRouter or WeakRouter in your view controllers or view models instead. -You can create them using the Coordinator.unownedRouter and Coordinator.weakRouter properties. - -
- -
-
- -
-
-
-
- - - -

Initialization

- -
-
    -
  • -
    - - - - init(_:) - -
    -
    -
    -
    -
    -
    -

    Creates a StrongRouter object from a given router.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init<T>(_ router: T) where RouteType == T.RouteType, T : Router
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - router - - -
    -

    The source router.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Public methods

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Triggers routes and provides the transition context in the completion-handler.

    - -

    Useful for deep linking. It is encouraged to use trigger instead, if the context is not needed.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func contextTrigger(_ route: RouteType,
-                           with options: TransitionOptions,
-                           completion: ContextPresentationHandler?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - route - - -
    -

    The route to be triggered.

    -
    -
    - - options - - -
    -

    Transition options configuring the execution of transitions, e.g. whether it should be animated.

    -
    -
    - - completion - - -
    -

    If present, this completion handler is executed once the transition is completed -(including animations). -If the context is not needed, use trigger instead.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Triggers the specified route by performing a transition.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func trigger(_ route: RouteType, with options: TransitionOptions, completion: PresentationHandler?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - route - - -
    -

    The route to be triggered.

    -
    -
    - - options - - -
    -

    Transition options for performing the transition, e.g. whether it should be animated.

    -
    -
    - - completion - - -
    -

    If present, this completion handler is executed once the transition is completed -(including animations).

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - presented(from:) - -
    -
    -
    -
    -
    -
    -

    This method is called whenever a Presentable is shown to the user. -It further provides information about the presentable responsible for the presenting.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func presented(from presentable: Presentable?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - presentable - - -
    -

    The context in which the presentable is shown. -This could be a window, another viewController, a coordinator, etc. -nil is specified whenever a context cannot be easily determined.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - viewController - -
    -
    -
    -
    -
    -
    -

    The viewController of the Presentable.

    - -

    In the case of a UIViewController, it returns itself. -A coordinator returns its rootViewController.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var viewController: UIViewController! { get }
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - registerParent(_:) - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func registerParent(_ presentable: Presentable & AnyObject)
    - -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func childTransitionCompleted()
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Classes/TabBarAnimationDelegate.html b/docs/Classes/TabBarAnimationDelegate.html deleted file mode 100644 index dc902646..00000000 --- a/docs/Classes/TabBarAnimationDelegate.html +++ /dev/null @@ -1,725 +0,0 @@ - - - - TabBarAnimationDelegate Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - TabBarAnimationDelegate Class Reference -

- -
- -
- -
-
-

TabBarAnimationDelegate

-
-
- 
open class TabBarAnimationDelegate : NSObject
- -
-
-

TabBarAnimationDelegate is used as the delegate of a TabBarCoordinator’s rootViewController -to allow for transitions to specify transition animations.

- -

TabBarAnimationDelegate conforms to the UITabBarControllerDelegate protocol -and is intended for use as the delegate of one tabbar controller only.

-
-

Note

- Do not override the delegate of a TabBarCoordinator’s rootViewController-delegate. -Instead use the delegate property of the TabBarCoordinator itself. - -
- -
-
- -
-
-
-
- - - -

UITabBarControllerDelegate

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    See UITabBarControllerDelegate -for further reference.

    - -
      -

    • Parameters

      - -
        -
      • tabBarController: The delegate owner.
        • -
      • animationController: The animationController to return the interactionController for.
        • -
      • -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func tabBarController(_ tabBarController: UITabBarController,
-                           interactionControllerFor animationController: UIViewControllerAnimatedTransitioning
-    ) -> UIViewControllerInteractiveTransitioning?
    - -
    -
    -
    -

    Return Value

    -

    If the animationController is a TransitionAnimation, it returns its interactionController. -Otherwise it requests an interactionController from the TabBarCoordinator’s delegate.

    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UITabBarControllerDelegate -for further reference.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func tabBarController(_ tabBarController: UITabBarController,
-                           animationControllerForTransitionFrom fromVC: UIViewController,
-                           to toVC: UIViewController) -> UIViewControllerAnimatedTransitioning?
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - tabBarController - - -
    -

    The delegate owner.

    -
    -
    - - fromVC - - -
    -

    The source view controller of the transition.

    -
    -
    - - toVC - - -
    -

    The destination view controller of the transition.

    -
    -
    -
    -
    -

    Return Value

    -

    The presentation animation controller from the toVC’s transitioningDelegate. -If not present, it uses the TabBarCoordinator’s delegate as fallback.

    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UITabBarControllerDelegate -for further reference.

    - -

    This method delegates to the TabBarCoordinator’s delegate.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func tabBarController(_ tabBarController: UITabBarController,
-                           didSelect viewController: UIViewController)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - tabBarController - - -
    -

    The delegate owner.

    -
    -
    - - viewController - - -
    -

    The destination viewController.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UITabBarControllerDelegate -for further reference.

    - -

    This method delegates to the TabBarCoordinator’s delegate.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func tabBarController(_ tabBarController: UITabBarController,
-                           shouldSelect viewController: UIViewController) -> Bool
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - tabBarController - - -
    -

    The delegate owner.

    -
    -
    - - viewController - - -
    -

    The destination viewController.

    -
    -
    -
    -
    -

    Return Value

    -

    The result of the TabBarCooordinator’s delegate. If not specified, it returns true.

    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UITabBarControllerDelegate -for further reference.

    - -

    This method delegates to the TabBarCoordinator’s delegate.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func tabBarController(_ tabBarController: UITabBarController,
-                           willBeginCustomizing viewControllers: [UIViewController])
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - tabBarController - - -
    -

    The delegate owner.

    -
    -
    - - viewControllers - - -
    -

    The source viewControllers.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UITabBarControllerDelegate -for further reference.

    - -

    This method delegates to the TabBarCoordinator’s delegate.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func tabBarController(_ tabBarController: UITabBarController,
-                           didEndCustomizing viewControllers: [UIViewController], changed: Bool)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - tabBarController - - -
    -

    The delegate owner.

    -
    -
    - - viewControllers - - -
    -

    The source viewControllers.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UITabBarControllerDelegate -for further reference.

    - -

    This method delegates to the TabBarCoordinator’s delegate.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func tabBarController(_ tabBarController: UITabBarController,
-                           willEndCustomizing viewControllers: [UIViewController], changed: Bool)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - tabBarController - - -
    -

    The delegate owner.

    -
    -
    - - viewControllers - - -
    -

    The source viewControllers.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Classes/TabBarCoordinator.html b/docs/Classes/TabBarCoordinator.html deleted file mode 100644 index 76bec17b..00000000 --- a/docs/Classes/TabBarCoordinator.html +++ /dev/null @@ -1,512 +0,0 @@ - - - - TabBarCoordinator Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - TabBarCoordinator Class Reference -

- -
- -
- -
-
-

TabBarCoordinator

-
-
- 
open class TabBarCoordinator<RouteType> : BaseCoordinator<RouteType, TabBarTransition> where RouteType : Route
- -
-
-

Use a TabBarCoordinator to coordinate a flow where a UITabbarController serves as a rootViewController. -With a TabBarCoordinator, you get access to all tabbarController-related transitions.

- -
-
- -
-
-
-
- - - -

Computed properties

- -
-
    -
  • -
    - - - - delegate - -
    -
    -
    -
    -
    -
    -

    Use this delegate to get informed about tabbarController-related notifications and delegate methods -specifying transition animations. The delegate is only referenced weakly.

    - -

    Set this delegate instead of overriding the delegate of the rootViewController -specified in the initializer, if possible, to allow for transition animations -to be executed as specified in the prepareTransition(for:) method.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var delegate: UITabBarControllerDelegate? { get set }
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Initialization

- -
-
    -
  • - -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public override init(rootViewController: RootViewController = .init(), initialRoute: RouteType?)
    - -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Creates a TabBarCoordinator with a specified set of tabs.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(rootViewController: RootViewController = .init(), tabs: [Presentable])
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - tabs - - -
    -

    The presentables to be used as tabs.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Creates a TabBarCoordinator with a specified set of tabs and selects a specific presentable.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(rootViewController: RootViewController = .init(), tabs: [Presentable], select: Presentable)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - tabs - - -
    -

    The presentables to be used as tabs.

    -
    -
    - - select - - -
    -

    The presentable to be selected before displaying. Make sure, this presentable is one of the -specified tabs in the other parameter.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Creates a TabBarCoordinator with a specified set of tabs and selects a presentable at a given index.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(rootViewController: RootViewController = .init(), tabs: [Presentable], select: Int)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - tabs - - -
    -

    The presentables to be used as tabs.

    -
    -
    - - select - - -
    -

    The index of the presentable to be selected before displaying.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Classes/ViewCoordinator.html b/docs/Classes/ViewCoordinator.html deleted file mode 100644 index d9cd3ad3..00000000 --- a/docs/Classes/ViewCoordinator.html +++ /dev/null @@ -1,305 +0,0 @@ - - - - ViewCoordinator Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - ViewCoordinator Class Reference -

- -
- -
- -
-
-

ViewCoordinator

-
-
- 
open class ViewCoordinator<RouteType> : BaseCoordinator<RouteType, ViewTransition> where RouteType : Route
- -
-
-

ViewCoordinator is a base class for custom coordinators with a UIViewController rootViewController.

- -
-
- -
-
-
-
- - - -

Initialization

- -
-
    -
  • - -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public override init(rootViewController: RootViewController, initialRoute: RouteType? = nil)
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Extensions.html b/docs/Extensions.html deleted file mode 100644 index 83651e5a..00000000 --- a/docs/Extensions.html +++ /dev/null @@ -1,327 +0,0 @@ - - - - Extensions Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - Extensions Reference -

- -
- -
- -
-
-

Extensions

-

The following extensions are available globally.

- -
-
- -
-
-
-
- - - -

Extensions

- -
- -
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Extensions/UIView.html b/docs/Extensions/UIView.html deleted file mode 100644 index 7b36d198..00000000 --- a/docs/Extensions/UIView.html +++ /dev/null @@ -1,323 +0,0 @@ - - - - UIView Extension Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - UIView Extension Reference -

- -
- -
- -
-
-

UIView

-
-
- 
extension UIView: Container
- -
-
- -
-
- -
-
-
-
    -
  • -
    - - - - viewController - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var viewController: UIViewController! { get }
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - view - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var view: UIView! { get }
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Extensions/UIViewController.html b/docs/Extensions/UIViewController.html deleted file mode 100644 index 0115ec93..00000000 --- a/docs/Extensions/UIViewController.html +++ /dev/null @@ -1,297 +0,0 @@ - - - - UIViewController Extension Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - UIViewController Extension Reference -

- -
- -
- -
-
-

UIViewController

-
-
- 
extension UIViewController: Container
- -
-
- -
-
- -
-
-
-
    -
  • -
    - - - - viewController - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var viewController: UIViewController! { get }
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Protocols.html b/docs/Protocols.html deleted file mode 100644 index 46c84776..00000000 --- a/docs/Protocols.html +++ /dev/null @@ -1,616 +0,0 @@ - - - - Protocols Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - Protocols Reference -

- -
- -
- -
-
-

Protocols

-

The following protocols are available globally.

- -
-
- -
-
-
-
    -
  • -
    - - - - Container - -
    -
    -
    -
    -
    -
    -

    Container abstracts away from the difference of UIView and UIViewController

    - -

    With the Container protocol, UIView and UIViewController objects can be used interchangeably, -e.g. when embedding containers into containers.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public protocol Container
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - Coordinator - -
    -
    -
    -
    -
    -
    -

    Coordinator is the protocol every coordinator conforms to.

    - -

    It requires an object to be able to trigger routes and perform transitions. -This connection is created using the prepareTransition(for:) method.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public protocol Coordinator : Router, TransitionPerformer
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - TransitionContext - -
    -
    -
    -
    -
    -
    -

    TransitionContext provides context information about transitions.

    - -

    It is especially useful for deep linking as XCoordinator can internally gather information about -the presentables being pushed onto the view hierarchy.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public protocol TransitionContext
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - Presentable - -
    -
    -
    -
    -
    -
    -

    Presentable represents all objects that can be presented (i.e. shown) to the user.

    - -

    Therefore, it is useful for view controllers, coordinators and views. -Presentable is often used for transitions to allow for view controllers and coordinators to be transitioned to.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public protocol Presentable
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - Route - -
    -
    -
    -
    -
    -
    -

    This is the protocol your route types need to conform to.

    -
    -

    Note

    - It has no requirements, although the use of enums is encouraged to make your -navigation code type safe. - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public protocol Route
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - Router - -
    -
    -
    -
    -
    -
    -

    The Router protocol is used to abstract the transition-type specific characteristics of a Coordinator.

    - -

    A Router can trigger routes, which lead to transitions being executed. In constrast to the Coordinator protocol, -the router does not specify a TransitionType and can therefore be used in the form of a -StrongRouter, UnownedRouter or WeakRouter to reduce a coordinator’s capabilities to -the triggering of routes. -This may especially be useful in viewModels when using them in different contexts.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public protocol Router : Presentable
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - TransitionAnimation - -
    -
    -
    -
    -
    -
    -

    TransitionAnimation aims to provide a common protocol for any type of transition animation used in an Animation object.

    - -

    XCoordinator provides different implementations of this protocol with the StaticTransitionAnimation, -InteractiveTransitionAnimation and InterruptibleTransitionAnimation classes.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public protocol TransitionAnimation : UIViewControllerAnimatedTransitioning
    - -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    PercentDrivenInteractionController is used for interaction controller types that can updated based on a percentage of completion. -Furthermore, a PercentDrivenInteractionController should be able to cancel and finish a transition animation.

    - -

    PercentDrivenInteractionController is based on the UIViewControllerInteractiveTransitioning protocol.

    -
    -

    Note

    - While you can implement your custom implementation, -UIKit offers a default implementation with UIPercentDrivenInteractiveTransition. - -
    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public protocol PercentDrivenInteractionController : UIViewControllerInteractiveTransitioning
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - TransitionPerformer - -
    -
    -
    -
    -
    -
    -

    The TransitionPerformer protocol is used to abstract the route-type specific characteristics of a Coordinator. -It keeps type information about its transition performing capabilities.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public protocol TransitionPerformer : Presentable
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - TransitionProtocol - -
    -
    -
    -
    -
    -
    -

    TransitionProtocol is used to abstract any concrete transition implementation.

    - -

    Transition is provided as an easily-extensible default transition type implementation.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public protocol TransitionProtocol : TransitionContext
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Protocols/Container.html b/docs/Protocols/Container.html deleted file mode 100644 index 2a868a42..00000000 --- a/docs/Protocols/Container.html +++ /dev/null @@ -1,339 +0,0 @@ - - - - Container Protocol Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - Container Protocol Reference -

- -
- -
- -
-
-

Container

-
-
- 
public protocol Container
- -
-
-

Container abstracts away from the difference of UIView and UIViewController

- -

With the Container protocol, UIView and UIViewController objects can be used interchangeably, -e.g. when embedding containers into containers.

- -
-
- -
-
-
-
    -
  • -
    - - - - view - -
    -
    -
    -
    -
    -
    -

    The view of the Container.

    -
    -

    Note

    - It might not exist for a UIViewController. - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    var view: UIView! { get }
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - viewController - -
    -
    -
    -
    -
    -
    -

    The viewController of the Container.

    -
    -

    Note

    - It might not exist for a UIView. - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    var viewController: UIViewController! { get }
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Protocols/Coordinator.html b/docs/Protocols/Coordinator.html deleted file mode 100644 index 6fd1b16b..00000000 --- a/docs/Protocols/Coordinator.html +++ /dev/null @@ -1,996 +0,0 @@ - - - - Coordinator Protocol Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - Coordinator Protocol Reference -

- -
- -
- -
-
-

Coordinator

-
-
- 
public protocol Coordinator : Router, TransitionPerformer
- -
-
-

Coordinator is the protocol every coordinator conforms to.

- -

It requires an object to be able to trigger routes and perform transitions. -This connection is created using the prepareTransition(for:) method.

- -
-
- -
-
-
-
    -
  • - -
    -
    -
    -
    -
    -

    This method prepares transitions for routes. -It especially decides, which transitions are performed for the triggered routes.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func prepareTransition(for route: RouteType) -> TransitionType
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - route - - -
    -

    The triggered route for which a transition is to be prepared.

    -
    -
    -
    -
    -

    Return Value

    -

    The prepared transition.

    -
    -
    -
    -
    • -
  • -
    - - - - addChild(_:) - -
    -
    -
    -
    -
    -
    -

    This method adds a child to a coordinator’s children.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func addChild(_ presentable: Presentable)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - presentable - - -
    -

    The child to be added.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - removeChild(_:) - -
    -
    -
    -
    -
    -
    -

    This method removes a child to a coordinator’s children.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func removeChild(_ presentable: Presentable)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - presentable - - -
    -

    The child to be removed.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    This method removes all children that are no longer in the view hierarchy.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func removeChildrenIfNeeded()
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Typealiases

- -
-
    -
  • -
    - - - - RootViewController - - - Extension method - -
    -
    -
    -
    -
    -
    -

    Shortcut for Coordinator.TransitionType.RootViewController

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public typealias RootViewController = TransitionType.RootViewController
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Presentable

- -
-
    -
  • -
    - - - - viewController - - - Extension method - -
    -
    -
    -
    -
    -
    -

    A Coordinator uses its rootViewController as viewController.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var viewController: UIViewController! { get }
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Presentable

- -
-
    -
  • -
    - - - - weakRouter - - - Extension method - -
    -
    -
    -
    -
    -
    -

    Creates a WeakRouter object from the given router to abstract from concrete implementations -while maintaining information necessary to fulfill the Router protocol. -The original router will be held weakly.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var weakRouter: WeakRouter<RouteType> { get }
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - unownedRouter - - - Extension method - -
    -
    -
    -
    -
    -
    -

    Creates an UnownedRouter object from the given router to abstract from concrete implementations -while maintaining information necessary to fulfill the Router protocol. -The original router will be held unowned.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var unownedRouter: UnownedRouter<RouteType> { get }
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Default implementations

- -
-
    -
  • -
    - - - - anyCoordinator - - - Extension method - -
    -
    -
    -
    -
    -
    -

    Creates an AnyCoordinator based on the current coordinator.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var anyCoordinator: AnyCoordinator<RouteType, TransitionType> { get }
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - presented(from:) - - - Extension method - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func presented(from presentable: Presentable?)
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - childTransitionCompleted() - - - Extension method - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func childTransitionCompleted()
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - contextTrigger(_:with:completion:) - - - Extension method - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func contextTrigger(_ route: RouteType,
-                           with options: TransitionOptions,
-                           completion: ContextPresentationHandler?)
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - chain(routes:) - - - Extension method - -
    -
    -
    -
    -
    -
    -

    With chain(routes:) different routes can be chained together to form a combined transition.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func chain(routes: [RouteType]) -> TransitionType
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - routes - - -
    -

    The routes to be chained.

    -
    -
    -
    -
    -

    Return Value

    -

    A transition combining the transitions of the specified routes.

    -
    -
    -
    -
    • -
  • -
    - - - - performTransition(_:with:completion:) - - - Extension method - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func performTransition(_ transition: TransitionType,
-                              with options: TransitionOptions,
-                              completion: PresentationHandler? = nil)
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Coordinator + DeepLinking

- -
-
    -
  • -
    - - - - deepLink(_:_:) - - - Extension method - -
    -
    -
    -
    -
    -
    -

    Deep-Linking can be used to chain routes of different types together.

    -
    -

    Note

    -

    Use it with caution, as it is not implemented in a type-safe manner. -Keep in mind that changes in the app’s structure and changes of transitions -behind the given routes can lead to runtime errors and, therefore, crashes of your app.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func deepLink<RootViewController, S: Sequence>(_ route: RouteType, _ remainingRoutes: S)
-    -> Transition<RootViewController> where S.Element == Route, TransitionType == Transition<RootViewController>
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - route - - -
    -

    The first route in the chain. -It is given a special place because its exact type can be specified.

    -
    -
    - - remainingRoutes - - -
    -

    The remaining routes of the chain.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - deepLink(_:_:) - - - Extension method - -
    -
    -
    -
    -
    -
    -

    Deep-Linking can be used to chain routes of different types together.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func deepLink<RootViewController>(_ route: RouteType, _ remainingRoutes: Route...)
-    -> Transition<RootViewController> where TransitionType == Transition<RootViewController>
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - registerPeek(for:route:) - - - Extension method - -
    -
    -
    -
    -
    -
    -

    Use this transition to register 3D Touch Peek and Pop functionality.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    @available(iOS, introduced: 9.0, deprecated: 13.0, message: "Use `UIContextMenuInteraction` instead.")
-public func registerPeek<RootViewController>(for source: Container,
-                                             route: RouteType
-    ) -> Transition<RootViewController> where Self.TransitionType == Transition<RootViewController>
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - source - - -
    -

    The view to register peek and pop on.

    -
    -
    - - route - - -
    -

    The route to be triggered for peek and pop.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Protocols/PercentDrivenInteractionController.html b/docs/Protocols/PercentDrivenInteractionController.html deleted file mode 100644 index c0d3e12d..00000000 --- a/docs/Protocols/PercentDrivenInteractionController.html +++ /dev/null @@ -1,365 +0,0 @@ - - - - PercentDrivenInteractionController Protocol Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - PercentDrivenInteractionController Protocol Reference -

- -
- -
- -
-
-

PercentDrivenInteractionController

-
-
- 
public protocol PercentDrivenInteractionController : UIViewControllerInteractiveTransitioning
- -
-
-

PercentDrivenInteractionController is used for interaction controller types that can updated based on a percentage of completion. -Furthermore, a PercentDrivenInteractionController should be able to cancel and finish a transition animation.

- -

PercentDrivenInteractionController is based on the UIViewControllerInteractiveTransitioning protocol.

-
-

Note

- While you can implement your custom implementation, -UIKit offers a default implementation with UIPercentDrivenInteractiveTransition. - -
- -
-
- -
-
-
-
    -
  • -
    - - - - update(_:) - -
    -
    -
    -
    -
    -
    -

    Updates the animation to be at the specified progress.

    - -

    This method is called based on user interactions. -A linear progression of the animation is encouraged when handling user interactions.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func update(_ percentComplete: CGFloat)
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - cancel() - -
    -
    -
    -
    -
    -
    -

    Cancels the animation, e.g. by cleaning up and reversing any progress made.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func cancel()
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - finish() - -
    -
    -
    -
    -
    -
    -

    Finishes the animation by completing it from the current progress onwards.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func finish()
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Protocols/Presentable.html b/docs/Protocols/Presentable.html deleted file mode 100644 index def33f99..00000000 --- a/docs/Protocols/Presentable.html +++ /dev/null @@ -1,551 +0,0 @@ - - - - Presentable Protocol Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - Presentable Protocol Reference -

- -
- -
- -
-
-

Presentable

-
-
- 
public protocol Presentable
- -
-
-

Presentable represents all objects that can be presented (i.e. shown) to the user.

- -

Therefore, it is useful for view controllers, coordinators and views. -Presentable is often used for transitions to allow for view controllers and coordinators to be transitioned to.

- -
-
- -
-
-
-
    -
  • -
    - - - - viewController - -
    -
    -
    -
    -
    -
    -

    The viewController of the Presentable.

    - -

    In the case of a UIViewController, it returns itself. -A coordinator returns its rootViewController.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    var viewController: UIViewController! { get }
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - router(for:) - - - Default implementation - -
    -
    -
    -
    -
    -
    -

    This method can be used to retrieve whether the presentable can trigger a specific route -and potentially returns a router to trigger the route on.

    - -

    Deep linking makes use of this method to trigger the specified routes.

    - -
    -

    Default Implementation

    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func router<R>(for route: R) -> StrongRouter<R>? where R : Route
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - route - - -
    -

    The route to determine a router for.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - presented(from:) - - - Default implementation - -
    -
    -
    -
    -
    -
    -

    This method is called whenever a Presentable is shown to the user. -It further provides information about the context a presentable is shown in.

    - -
    -

    Default Implementation

    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func presented(from presentable: Presentable?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - presentable - - -
    -

    The context in which the presentable is shown. -This could be a window, another viewController, a coordinator, etc. -nil is specified whenever a context cannot be easily determined.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - registerParent(_:) - - - Default implementation - -
    -
    -
    -
    -
    -
    -

    This method is used to register a parent coordinator to a child coordinator.

    -
    -

    Note

    - This method is used internally and should never be called directly. - -
    - -
    -

    Default Implementation

    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func registerParent(_ presentable: Presentable & AnyObject)
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - childTransitionCompleted() - - - Default implementation - -
    -
    -
    -
    -
    -
    -

    This method gets called when the transition of a child coordinator is being reported to its parent.

    -
    -

    Note

    - This method is used internally and should never be called directly. - -
    - -
    -

    Default Implementation

    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func childTransitionCompleted()
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - setRoot(for:) - - - Default implementation - -
    -
    -
    -
    -
    -
    -

    Sets the presentable as the root of the window.

    - -

    This method sets the rootViewController of the window and makes it key and visible. -Furthermore, it calls presented(from:) with the window as its parameter.

    - -
    -

    Default Implementation

    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func setRoot(for window: UIWindow)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - window - - -
    -

    The window to set the root of.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Protocols/Router.html b/docs/Protocols/Router.html deleted file mode 100644 index 29ffd2c0..00000000 --- a/docs/Protocols/Router.html +++ /dev/null @@ -1,685 +0,0 @@ - - - - Router Protocol Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - Router Protocol Reference -

- -
- -
- -
-
-

Router

-
-
- 
public protocol Router : Presentable
- -
-
-

The Router protocol is used to abstract the transition-type specific characteristics of a Coordinator.

- -

A Router can trigger routes, which lead to transitions being executed. In constrast to the Coordinator protocol, -the router does not specify a TransitionType and can therefore be used in the form of a -StrongRouter, UnownedRouter or WeakRouter to reduce a coordinator’s capabilities to -the triggering of routes. -This may especially be useful in viewModels when using them in different contexts.

- -
-
- -
-
-
-
    -
  • -
    - - - - RouteType - -
    -
    -
    -
    -
    -
    -

    RouteType defines which routes can be triggered in a certain Router implementation.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    associatedtype RouteType : Route
    - -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Triggers routes and returns context in completion-handler.

    - -

    Useful for deep linking. It is encouraged to use trigger instead, if the context is not needed.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func contextTrigger(_ route: RouteType, with options: TransitionOptions, completion: ContextPresentationHandler?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - route - - -
    -

    The route to be triggered.

    -
    -
    - - options - - -
    -

    Transition options configuring the execution of transitions, e.g. whether it should be animated.

    -
    -
    - - completion - - -
    -

    If present, this completion handler is executed once the transition is completed -(including animations). -If the context is not needed, use trigger instead.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Convenience methods

- -
-
    -
  • -
    - - - - trigger(_:with:) - - - Extension method - -
    -
    -
    -
    -
    -
    -

    Triggers the specified route without the need of specifying a completion handler.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func trigger(_ route: RouteType, with options: TransitionOptions)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - route - - -
    -

    The route to be triggered.

    -
    -
    - - options - - -
    -

    Transition options for performing the transition, e.g. whether it should be animated.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - trigger(_:completion:) - - - Extension method - -
    -
    -
    -
    -
    -
    -

    Triggers the specified route with default transition options enabling the animation of the transition.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func trigger(_ route: RouteType, completion: PresentationHandler? = nil)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - route - - -
    -

    The route to be triggered.

    -
    -
    - - completion - - -
    -

    If present, this completion handler is executed once the transition is completed -(including animations).

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - trigger(_:with:completion:) - - - Extension method - -
    -
    -
    -
    -
    -
    -

    Triggers the specified route by performing a transition.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func trigger(_ route: RouteType, with options: TransitionOptions, completion: PresentationHandler?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - route - - -
    -

    The route to be triggered.

    -
    -
    - - options - - -
    -

    Transition options for performing the transition, e.g. whether it should be animated.

    -
    -
    - - completion - - -
    -

    If present, this completion handler is executed once the transition is completed -(including animations).

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Computed properties

- -
-
    -
  • -
    - - - - strongRouter - - - Extension method - -
    -
    -
    -
    -
    -
    -

    Creates a StrongRouter object from the given router to abstract from concrete implementations -while maintaining information necessary to fulfill the Router protocol. -The original router will be held strongly.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var strongRouter: StrongRouter<RouteType> { get }
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - router(for:) - - - Extension method - -
    -
    -
    -
    -
    -
    -

    Returns a router for the specified route, if possible.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func router<R>(for route: R) -> StrongRouter<R>? where R : Route
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - route - - -
    -

    The route type to return a router for.

    -
    -
    -
    -
    -

    Return Value

    -

    It returns the router’s strongRouter, -if it is compatible with the given route type, -otherwise nil.

    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Protocols/TransitionAnimation.html b/docs/Protocols/TransitionAnimation.html deleted file mode 100644 index da9eb644..00000000 --- a/docs/Protocols/TransitionAnimation.html +++ /dev/null @@ -1,362 +0,0 @@ - - - - TransitionAnimation Protocol Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - TransitionAnimation Protocol Reference -

- -
- -
- -
-
-

TransitionAnimation

-
-
- 
public protocol TransitionAnimation : UIViewControllerAnimatedTransitioning
- -
-
-

TransitionAnimation aims to provide a common protocol for any type of transition animation used in an Animation object.

- -

XCoordinator provides different implementations of this protocol with the StaticTransitionAnimation, -InteractiveTransitionAnimation and InterruptibleTransitionAnimation classes.

- -
-
- -
-
-
-
    -
  • -
    - - - - interactionController - -
    -
    -
    -
    -
    -
    -

    The interaction controller of an animation. -It gets notified about the state of an animation and handles the specific events accordingly.

    - -

    The interaction controller is reset when calling TransitionAnimation.start() can always be nil, -e.g. in static transition animations.

    - -

    Until TransitionAnimation.cleanup() is called, it should always return the same instance.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    var interactionController: PercentDrivenInteractionController? { get }
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - start() - -
    -
    -
    -
    -
    -
    -

    Starts the animation by possibly creating a new interaction controller.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func start()
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - cleanup() - -
    -
    -
    -
    -
    -
    -

    Cleans up a TransitionAnimation after an animation has been completed, e.g. by deleting an interaction controller.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func cleanup()
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Protocols/TransitionContext.html b/docs/Protocols/TransitionContext.html deleted file mode 100644 index f519a608..00000000 --- a/docs/Protocols/TransitionContext.html +++ /dev/null @@ -1,335 +0,0 @@ - - - - TransitionContext Protocol Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - TransitionContext Protocol Reference -

- -
- -
- -
-
-

TransitionContext

-
-
- 
public protocol TransitionContext
- -
-
-

TransitionContext provides context information about transitions.

- -

It is especially useful for deep linking as XCoordinator can internally gather information about -the presentables being pushed onto the view hierarchy.

- -
-
- -
-
-
-
    -
  • -
    - - - - presentables - -
    -
    -
    -
    -
    -
    -

    The presentables being shown to the user by the transition.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    var presentables: [Presentable] { get }
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - animation - -
    -
    -
    -
    -
    -
    -

    The transition animation directly used in the transition, if applicable.

    -
    -

    Note

    - Make sure to not return nil, if you want to use BaseCoordinator.registerInteractiveTransition -to realize an interactive transition. - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    var animation: TransitionAnimation? { get }
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Protocols/TransitionPerformer.html b/docs/Protocols/TransitionPerformer.html deleted file mode 100644 index 0df5becf..00000000 --- a/docs/Protocols/TransitionPerformer.html +++ /dev/null @@ -1,403 +0,0 @@ - - - - TransitionPerformer Protocol Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - TransitionPerformer Protocol Reference -

- -
- -
- -
-
-

TransitionPerformer

-
-
- 
public protocol TransitionPerformer : Presentable
- -
-
-

The TransitionPerformer protocol is used to abstract the route-type specific characteristics of a Coordinator. -It keeps type information about its transition performing capabilities.

- -
-
- -
-
-
-
    -
  • -
    - - - - TransitionType - -
    -
    -
    -
    -
    -
    -

    The type of transitions that can be executed on the rootViewController.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    associatedtype TransitionType : TransitionProtocol
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - rootViewController - -
    -
    -
    -
    -
    -
    -

    The rootViewController on which transitions are performed.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    var rootViewController: TransitionType.RootViewController { get }
    - -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Perform a transition.

    -
    -

    Warning

    -

    Do not use this method directly, but instead try to use the trigger -method of your coordinator instead wherever possible.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func performTransition(_ transition: TransitionType, with options: TransitionOptions, completion: PresentationHandler?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - transition - - -
    -

    The transition to be performed.

    -
    -
    - - options - - -
    -

    The options on how to perform the transition, including the option to enable/disable animations.

    -
    -
    - - completion - - -
    -

    The completion handler called once a transition has finished.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Protocols/TransitionProtocol.html b/docs/Protocols/TransitionProtocol.html deleted file mode 100644 index 30e2c3eb..00000000 --- a/docs/Protocols/TransitionProtocol.html +++ /dev/null @@ -1,399 +0,0 @@ - - - - TransitionProtocol Protocol Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - TransitionProtocol Protocol Reference -

- -
- -
- -
-
-

TransitionProtocol

-
-
- 
public protocol TransitionProtocol : TransitionContext
- -
-
-

TransitionProtocol is used to abstract any concrete transition implementation.

- -

Transition is provided as an easily-extensible default transition type implementation.

- -
-
- -
-
-
-
    -
  • -
    - - - - RootViewController - -
    -
    -
    -
    -
    -
    -

    The type of the rootViewController that can execute the transition.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    associatedtype RootViewController : UIViewController
    - -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Performs a transition on the given viewController.

    -
    -

    Warning

    - Do not call this method directly. Instead use your coordinator’s performTransition method or trigger -a specified route (latter option is encouraged). - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func perform(on rootViewController: RootViewController, with options: TransitionOptions, completion: PresentationHandler?)
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Always accessible transitions

- -
-
    -
  • -
    - - - - multiple(_:) - - - Default implementation - -
    -
    -
    -
    -
    -
    -

    Creates a compound transition by chaining multiple transitions together.

    - -
    -

    Default Implementation

    -
    -

    Creates a compound transition by chaining multiple transitions together.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    static func multiple(_ transitions: [Self]) -> Self
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - transitions - - -
    -

    The transitions to be chained to form a combined transition.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Structs.html b/docs/Structs.html deleted file mode 100644 index d6d9eafd..00000000 --- a/docs/Structs.html +++ /dev/null @@ -1,469 +0,0 @@ - - - - Structures Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - Structures Reference -

- -
- -
- -
-
-

Structures

-

The following structures are available globally.

- -
-
- -
-
-
-
    -
  • -
    - - - - Transition - -
    -
    -
    -
    -
    -
    -

    This struct represents the common implementation of the TransitionProtocol. -It is used in every of the provided BaseCoordinator subclasses and provides all transitions implemented in XCoordinator.

    - -

    Transitions are defined by a Transition.Perform closure. -It further provides different context information such as Transition.presentable and Transition.animation. -You can create your own custom transitions using Transition.init(presentable:animation:perform:) or -use one of the many provided static functions to create the most common transitions.

    -
    -

    Note

    - Transitions have a generic constraint to the rootViewController in use. -Therefore, not all transitions are available in every coordinator. -Make sure to specify the RootViewController type of the TransitionType of your coordinator as precise as possible -to get all already available transitions. - -
    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public struct Transition<RootViewController> : TransitionProtocol where RootViewController : UIViewController
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - TransitionOptions - -
    -
    -
    -
    -
    -
    -

    TransitionOptions specifies transition customization points defined at the point of triggering a transition.

    - -

    You can use TransitionOptions to define whether or not a transition should be animated.

    -
    -

    Note

    - It might be extended in the future to enable more advanced customization options. - -
    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public struct TransitionOptions
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - UnownedErased - -
    -
    -
    -
    -
    -
    -

    UnownedErased is a property wrapper to hold objects with an unowned reference when using type-erasure.

    - -

    Create this wrapper using an initial value and a closure to create the type-erased object. -Make sure to not create an UnownedErased wrapper for already type-erased objects, -since their reference is most likely instantly lost.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    @propertyWrapper
-public struct UnownedErased<Value>
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - UnownedErased - -
    -
    -
    -
    -
    -
    -

    UnownedErased is a property wrapper to hold objects with an unowned reference when using type-erasure.

    - -

    Create this wrapper using an initial value and a closure to create the type-erased object. -Make sure to not create an UnownedErased wrapper for already type-erased objects, -since their reference is most likely instantly lost.

    - - See more -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - WeakErased - -
    -
    -
    -
    -
    -
    -

    WeakErased is a property wrapper to hold objects with a weak reference when using type-erasure.

    - -

    Create this wrapper using an initial value and a closure to create the type-erased object. -Make sure to not create a WeakErased wrapper for already type-erased objects, -since their reference is most likely instantly lost.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    @propertyWrapper
-public struct WeakErased<Value>
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - WeakErased - -
    -
    -
    -
    -
    -
    -

    WeakErased is a property wrapper to hold objects with a weak reference when using type-erasure.

    - -

    Create this wrapper using an initial value and a closure to create the type-erased object. -Make sure to not create a WeakErased wrapper for already type-erased objects, -since their reference is most likely instantly lost.

    - - See more -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Structs/Transition.html b/docs/Structs/Transition.html deleted file mode 100644 index a054d6f9..00000000 --- a/docs/Structs/Transition.html +++ /dev/null @@ -1,1772 +0,0 @@ - - - - Transition Structure Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - Transition Structure Reference -

- -
- -
- -
-
-

Transition

-
-
- 
public struct Transition<RootViewController> : TransitionProtocol where RootViewController : UIViewController
- -
-
-

This struct represents the common implementation of the TransitionProtocol. -It is used in every of the provided BaseCoordinator subclasses and provides all transitions implemented in XCoordinator.

- -

Transitions are defined by a Transition.Perform closure. -It further provides different context information such as Transition.presentable and Transition.animation. -You can create your own custom transitions using Transition.init(presentable:animation:perform:) or -use one of the many provided static functions to create the most common transitions.

-
-

Note

- Transitions have a generic constraint to the rootViewController in use. -Therefore, not all transitions are available in every coordinator. -Make sure to specify the RootViewController type of the TransitionType of your coordinator as precise as possible -to get all already available transitions. - -
- -
-
- -
-
-
-
- - - -

Typealias

- -
-
    -
  • -
    - - - - PerformClosure - -
    -
    -
    -
    -
    -
    -

    Perform is the type of closure used to perform the transition.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public typealias PerformClosure = (_ rootViewController: RootViewController, _ options: TransitionOptions, _ completion: PresentationHandler?) -> Void
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - rootViewController - - -
    -

    The rootViewController to perform the transition on.

    -
    -
    - - options - - -
    -

    The options on how to perform the transition, e.g. whether it should be animated or not.

    -
    -
    - - completion - - -
    -

    The completion handler of the transition. -It is called when the transition (including all animations) is completed.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Computed properties

- -
-
    -
  • -
    - - - - presentables - -
    -
    -
    -
    -
    -
    -

    The presentables this transition is putting into the view hierarchy. This is especially useful for -deep-linking.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var presentables: [Presentable] { get }
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - animation - -
    -
    -
    -
    -
    -
    -

    The transition animation this transition is using, i.e. the presentation or dismissal animation -of the specified Animation object. If the transition does not use any transition animations, nil -is returned.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var animation: TransitionAnimation? { get }
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Initialization

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Create your custom transitions with this initializer.

    - -

    Extending Transition with static functions to create transitions with this initializer -(instead of calling this initializer in your prepareTransition(for:) method) is advised -as it makes reuse easier.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(presentables: [Presentable], animationInUse: TransitionAnimation?, perform: @escaping PerformClosure)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - presentables - - -
    -

    The presentables this transition is putting into the view hierarchy, if specifiable. -These presentables are used in the deep-linking feature.

    -
    -
    - - animationInUse - - -
    -

    The transition animation this transition is using during the transition, i.e. the present animation -of a presenting transition or the dismissal animation of a dismissing transition. -Make sure to specify an animation here to use your transition with the -registerInteractiveTransition method in your coordinator.

    -
    -
    - - perform - - -
    -

    The perform closure executes the transition. -To create custom transitions, make sure to call the completion handler after all animations are done. -If applicable, make sure to use the TransitionOptions to, e.g., decide whether a transition should be animated or not.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Methods

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Performs a transition on the given viewController.

    -
    -

    Warning

    - Do not call this method directly. Instead use your coordinator’s performTransition method or trigger -a specified route (latter option is encouraged). - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func perform(on rootViewController: RootViewController, with options: TransitionOptions, completion: PresentationHandler?)
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - push(_:animation:) - -
    -
    -
    -
    -
    -
    -

    Pushes a presentable on the rootViewController’s navigation stack.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func push(_ presentable: Presentable, animation: Animation? = nil) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - presentable - - -
    -

    The presentable to be pushed onto the navigation stack.

    -
    -
    - - animation - - -
    -

    The animation to set for the presentable. Its presentationAnimation will be used for the -immediate push-transition, its dismissalAnimation is used for the pop-transition, -if not otherwise specified. Specify nil here to leave animations as they were set for the -presentable before. You can use Animation.default to reset the previously set animations -on this presentable.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - pop(animation:) - -
    -
    -
    -
    -
    -
    -

    Pops the topViewController from the rootViewController’s navigation stack.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func pop(animation: Animation? = nil) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - animation - - -
    -

    The animation to set for the presentable. Only its dismissalAnimation is used for the -pop-transition. Specify nil here to leave animations as they were set for the -presentable before. You can use Animation.default to reset the previously set animations -on this presentable.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - pop(to:animation:) - -
    -
    -
    -
    -
    -
    -

    Pops viewControllers from the rootViewController’s navigation stack until the specified -presentable is reached.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func pop(to presentable: Presentable, animation: Animation? = nil) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - presentable - - -
    -

    The presentable to pop to. Make sure this presentable is in the rootViewController’s -navigation stack before performing such a transition.

    -
    -
    - - animation - - -
    -

    The animation to set for the presentable. Only its dismissalAnimation is used for the -pop-transition. Specify nil here to leave animations as they were set for the -presentable before. You can use Animation.default to reset the previously set animations -on this presentable.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - popToRoot(animation:) - -
    -
    -
    -
    -
    -
    -

    Pops viewControllers from the rootViewController’s navigation stack until only one viewController -is left.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func popToRoot(animation: Animation? = nil) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - animation - - -
    -

    The animation to set for the presentable. Only its dismissalAnimation is used for the -pop-transition. Specify nil here to leave animations as they were set for the -presentable before. You can use Animation.default to reset the previously set animations -on this presentable.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - set(_:animation:) - -
    -
    -
    -
    -
    -
    -

    Replaces the navigation stack of the rootViewController with the specified presentables.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func set(_ presentables: [Presentable], animation: Animation? = nil) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - presentables - - -
    -

    The presentables to make up the navigation stack after the transition is done.

    -
    -
    - - animation - - -
    -

    The animation to set for the presentable. Its presentationAnimation will be used for the -transition animation of the top-most viewController, its dismissalAnimation is used for -any pop-transition of the whole navigation stack, if not otherwise specified. Specify nil -here to leave animations as they were set for the presentables before. You can use -Animation.default to reset the previously set animations on all presentables.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - set(_:_:direction:) - -
    -
    -
    -
    -
    -
    -

    Sets the current page(s) of the rootViewController. Make sure to set -UIPageViewController.isDoubleSided to the appropriate setting before executing this transition.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func set(_ first: Presentable, _ second: Presentable? = nil,
-                       direction: UIPageViewController.NavigationDirection) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - first - - -
    -

    The first page being shown. If second is specified as nil, this reflects a single page -being shown.

    -
    -
    - - second - - -
    -

    The second page being shown. This page is optional, as your rootViewController can be used -with isDoubleSided enabled or not.

    -
    -
    - - direction - - -
    -

    The direction in which the transition should be animated.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - set(_:animation:) - -
    -
    -
    -
    -
    -
    -

    Transition to set the tabs of the rootViewController with an optional custom animation.

    -
    -

    Note

    -

    Only the presentation animation of the Animation object is used.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func set(_ presentables: [Presentable], animation: Animation? = nil) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - presentables - - -
    -

    The tabs to be set are defined by the presentables’ viewControllers.

    -
    -
    - - animation - - -
    -

    The animation to be used. If you specify nil here, the default animation by UIKit is used.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - select(_:animation:) - -
    -
    -
    -
    -
    -
    -

    Transition to select a tab with an optional custom animation.

    -
    -

    Note

    -

    Only the presentation animation of the Animation object is used.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func select(_ presentable: Presentable, animation: Animation? = nil) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - presentable - - -
    -

    The tab to be selected is the presentable’s viewController. Make sure that this is one of the -previously specified tabs of the rootViewController.

    -
    -
    - - animation - - -
    -

    The animation to be used. If you specify nil here, the default animation by UIKit is used.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Transition to select a tab with an optional custom animation.

    -
    -

    Note

    -

    Only the presentation animation of the Animation object is used.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func select(index: Int, animation: Animation? = nil) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - index - - -
    -

    The index of the tab to be selected. Make sure that there is a tab at the specified index.

    -
    -
    - - animation - - -
    -

    The animation to be used. If you specify nil here, the default animation by UIKit is used.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - show(_:) - -
    -
    -
    -
    -
    -
    -

    Shows a viewController by calling show on the rootViewController.

    -
    -

    Note

    -

    Prefer Transition.push when using transitions on a UINavigationController rootViewController. -In contrast to this transition, you can specify an animation.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func show(_ presentable: Presentable) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - presentable - - -
    -

    The presentable to be shown as a primary view controller.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - showDetail(_:) - -
    -
    -
    -
    -
    -
    -

    Shows a detail viewController by calling showDetail on the rootViewController.

    -
    -

    Note

    -

    Prefer Transition.push when using transitions on a UINavigationController rootViewController. -In contrast to this transition, you can specify an animation.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func showDetail(_ presentable: Presentable) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - presentable - - -
    -

    The presentable to be shown as a detail view controller.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Transition to present the given presentable on the rootViewController.

    - -

    The present-transition might also be helpful as it always presents on top of what is currently -presented.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func presentOnRoot(_ presentable: Presentable, animation: Animation? = nil) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - presentable - - -
    -

    The presentable to be presented.

    -
    -
    - - animation - - -
    -

    The animation to be set as the presentable’s transitioningDelegate. Specify nil to not override -the current transitioningDelegate and Animation.default to reset the transitioningDelegate to use -the default UIKit animations.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - present(_:animation:) - -
    -
    -
    -
    -
    -
    -

    Transition to present the given presentable. It uses the rootViewController’s presentedViewController, -if present, otherwise it is equivalent to presentOnRoot.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func present(_ presentable: Presentable, animation: Animation? = nil) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - presentable - - -
    -

    The presentable to be presented.

    -
    -
    - - animation - - -
    -

    The animation to be set as the presentable’s transitioningDelegate. Specify nil to not override -the current transitioningDelegate and Animation.default to reset the transitioningDelegate to use -the default UIKit animations.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - embed(_:in:) - -
    -
    -
    -
    -
    -
    -

    Transition to embed the given presentable in a specific container (i.e. a view or viewController).

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func embed(_ presentable: Presentable, in container: Container) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - presentable - - -
    -

    The presentable to be embedded.

    -
    -
    - - container - - -
    -

    The container to embed the presentable in.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Transition to call dismiss on the rootViewController. Also take a look at the dismiss transition, -which calls dismiss on the rootViewController’s presentedViewController, if present.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func dismissToRoot(animation: Animation? = nil) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - animation - - -
    -

    The animation to be used by the rootViewController’s presentedViewController. -Specify nil to not override its transitioningDelegate or Animation.default to fall back to the -default UIKit animations.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - dismiss(animation:) - -
    -
    -
    -
    -
    -
    -

    Transition to call dismiss on the rootViewController’s presentedViewController, if present. -Otherwise, it is equivalent to dismissToRoot.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func dismiss(animation: Animation? = nil) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - animation - - -
    -

    The animation to be used by the rootViewController’s presentedViewController. -Specify nil to not override its transitioningDelegate or Animation.default to fall back to the -default UIKit animations.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - none() - -
    -
    -
    -
    -
    -
    -

    No transition at all. May be useful for testing or debugging purposes, or to ignore specific -routes.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func none() -> Transition
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - multiple(_:) - -
    -
    -
    -
    -
    -
    -

    With this transition you can chain multiple transitions of the same type together.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func multiple<C>(_ transitions: C) -> Transition where C : Collection, C.Element == Transition<RootViewController>
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - transitions - - -
    -

    The transitions to be chained to form the new transition.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - route(_:on:) - -
    -
    -
    -
    -
    -
    -

    Use this transition to trigger a route on another coordinator. TransitionOptions and -PresentationHandler used during the execution of this transitions are forwarded.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func route<C>(_ route: C.RouteType, on coordinator: C) -> Transition where C : Coordinator
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - route - - -
    -

    The route to be triggered on the coordinator.

    -
    -
    - - coordinator - - -
    -

    The coordinator to trigger the route on.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - trigger(_:on:) - -
    -
    -
    -
    -
    -
    -

    Use this transition to trigger a route on another router. TransitionOptions and -PresentationHandler used during the execution of this transitions are forwarded.

    - -

    Peeking is not supported with this transition. If needed, use the route transition instead.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func trigger<R>(_ route: R.RouteType, on router: R) -> Transition where R : Router
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - route - - -
    -

    The route to be triggered on the coordinator.

    -
    -
    - - router - - -
    -

    The router to trigger the route on.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - perform(_:on:) - -
    -
    -
    -
    -
    -
    -

    Performs a transition on a different viewController than the coordinator’s rootViewController.

    - -

    This might be helpful when creating a coordinator for a specific viewController would create unnecessary complicated code.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func perform<TransitionType: TransitionProtocol>(_ transition: TransitionType,
-                                                               on viewController: TransitionType.RootViewController) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - transition - - -
    -

    The transition to be performed.

    -
    -
    - - viewController - - -
    -

    The viewController to perform the transition on.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Structs/TransitionOptions.html b/docs/Structs/TransitionOptions.html deleted file mode 100644 index 7a1d7027..00000000 --- a/docs/Structs/TransitionOptions.html +++ /dev/null @@ -1,376 +0,0 @@ - - - - TransitionOptions Structure Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - TransitionOptions Structure Reference -

- -
- -
- -
-
-

TransitionOptions

-
-
- 
public struct TransitionOptions
- -
-
-

TransitionOptions specifies transition customization points defined at the point of triggering a transition.

- -

You can use TransitionOptions to define whether or not a transition should be animated.

-
-

Note

- It might be extended in the future to enable more advanced customization options. - -
- -
-
- -
-
-
-
- - - -

Stored properties

- -
-
    -
  • -
    - - - - animated - -
    -
    -
    -
    -
    -
    -

    Specifies whether or not the transition should be animated.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public let animated: Bool
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Initialization

- -
-
    -
  • -
    - - - - init(animated:) - -
    -
    -
    -
    -
    -
    -

    Creates transition options on the basis of whether or not it should be animated.

    -
    -

    Note

    -

    Specifying true to enable animations does not necessarily lead to an animated transition, -if the transition does not support it.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(animated: Bool)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - animated - - -
    -

    Whether or not the animation should be animated.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Structs/UnownedErased.html b/docs/Structs/UnownedErased.html deleted file mode 100644 index 4386c53b..00000000 --- a/docs/Structs/UnownedErased.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - UnownedErased Structure Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - UnownedErased Structure Reference -

- -
- -
- -
-
-

UnownedErased

-

UnownedErased is a property wrapper to hold objects with an unowned reference when using type-erasure.

- -

Create this wrapper using an initial value and a closure to create the type-erased object. -Make sure to not create an UnownedErased wrapper for already type-erased objects, -since their reference is most likely instantly lost.

- -
-
- -
-
-
-
    -
  • -
    - - - - wrappedValue - -
    -
    -
    -
    -
    -
    -

    The type-erased or otherwise mapped version of the value being held unowned.

    - -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Structs/WeakErased.html b/docs/Structs/WeakErased.html deleted file mode 100644 index fb7d2d7b..00000000 --- a/docs/Structs/WeakErased.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - WeakErased Structure Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - WeakErased Structure Reference -

- -
- -
- -
-
-

WeakErased

-

WeakErased is a property wrapper to hold objects with a weak reference when using type-erasure.

- -

Create this wrapper using an initial value and a closure to create the type-erased object. -Make sure to not create a WeakErased wrapper for already type-erased objects, -since their reference is most likely instantly lost.

- -
-
- -
-
-
-
    -
  • -
    - - - - wrappedValue - -
    -
    -
    -
    -
    -
    -

    The type-erased or otherwise mapped version of the value being held weakly.

    - -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/Typealiases.html b/docs/Typealiases.html deleted file mode 100644 index c3f9b126..00000000 --- a/docs/Typealiases.html +++ /dev/null @@ -1,760 +0,0 @@ - - - - Type Aliases Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - Type Aliases Reference -

- -
- -
- -
-
-

Type Aliases

-

The following type aliases are available globally.

- -
-
- -
-
-
- -
-
- -
-
-
    -
  • -
    - - - - PresentationHandler - -
    -
    -
    -
    -
    -
    -

    The completion handler for transitions.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public typealias PresentationHandler = () -> Void
    - -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    The completion handler for transitions, which also provides the context information about the transition.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public typealias ContextPresentationHandler = (TransitionContext) -> Void
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - NavigationTransition - -
    -
    -
    -
    -
    -
    -

    NavigationTransition offers transitions that can be used -with a UINavigationController as rootViewController.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public typealias NavigationTransition = Transition<UINavigationController>
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - PageTransition - -
    -
    -
    -
    -
    -
    -

    PageTransition offers transitions that can be used -with a UIPageViewController rootViewController.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public typealias PageTransition = Transition<UIPageViewController>
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - SplitTransition - -
    -
    -
    -
    -
    -
    -

    SplitTransition offers different transitions common to a UISplitViewController rootViewController.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public typealias SplitTransition = Transition<UISplitViewController>
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - TabBarTransition - -
    -
    -
    -
    -
    -
    -

    TabBarTransition offers transitions that can be used -with a UITabBarController rootViewController.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public typealias TabBarTransition = Transition<UITabBarController>
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - AnyRouter - -
    -
    -
    -
    -
    -
    -

    Please use StrongRouter, WeakRouter or UnownedRouter instead.

    -
    -

    Note

    - Use a StrongRouter, if you need to hold a router even -when it is not in the view hierarchy. -Use a WeakRouter or UnownedRouter when you are accessing -any router from the view hierarchy. - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    @available(iOS, deprecated)
-public typealias AnyRouter<RouteType> = UnownedRouter<RouteType> where RouteType : Route
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - UnownedRouter - -
    -
    -
    -
    -
    -
    -

    An UnownedRouter is an unowned version of a router object to be used in view controllers or view models.

    -
    -

    Note

    - Do not create an UnownedRouter from a StrongRouter since StrongRouter is only another wrapper -and does not represent the might instantly - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public typealias UnownedRouter<RouteType> = UnownedErased<StrongRouter<RouteType>> where RouteType : Route
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - ViewTransition - -
    -
    -
    -
    -
    -
    -

    ViewTransition offers transitions common to any UIViewController rootViewController.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public typealias ViewTransition = Transition<UIViewController>
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - WeakRouter - -
    -
    -
    -
    -
    -
    -

    A WeakRouter is a weak version of a router object to be used in view controllers or view models.

    -
    -

    Note

    - Do not create a WeakRouter from a StrongRouter since StrongRouter is only another wrapper -and does not represent the might instantly. -Also keep in mind that once the original router object has been deallocated, -calling trigger on this wrapper will have no effect. - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public typealias WeakRouter<RouteType> = WeakErased<StrongRouter<RouteType>> where RouteType : Route
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/css/highlight.css b/docs/css/highlight.css deleted file mode 100644 index d0db0e13..00000000 --- a/docs/css/highlight.css +++ /dev/null @@ -1,200 +0,0 @@ -/* Credit to https://gist.github.com/wataru420/2048287 */ -.highlight { - /* Comment */ - /* Error */ - /* Keyword */ - /* Operator */ - /* Comment.Multiline */ - /* Comment.Preproc */ - /* Comment.Single */ - /* Comment.Special */ - /* Generic.Deleted */ - /* Generic.Deleted.Specific */ - /* Generic.Emph */ - /* Generic.Error */ - /* Generic.Heading */ - /* Generic.Inserted */ - /* Generic.Inserted.Specific */ - /* Generic.Output */ - /* Generic.Prompt */ - /* Generic.Strong */ - /* Generic.Subheading */ - /* Generic.Traceback */ - /* Keyword.Constant */ - /* Keyword.Declaration */ - /* Keyword.Pseudo */ - /* Keyword.Reserved */ - /* Keyword.Type */ - /* Literal.Number */ - /* Literal.String */ - /* Name.Attribute */ - /* Name.Builtin */ - /* Name.Class */ - /* Name.Constant */ - /* Name.Entity */ - /* Name.Exception */ - /* Name.Function */ - /* Name.Namespace */ - /* Name.Tag */ - /* Name.Variable */ - /* Operator.Word */ - /* Text.Whitespace */ - /* Literal.Number.Float */ - /* Literal.Number.Hex */ - /* Literal.Number.Integer */ - /* Literal.Number.Oct */ - /* Literal.String.Backtick */ - /* Literal.String.Char */ - /* Literal.String.Doc */ - /* Literal.String.Double */ - /* Literal.String.Escape */ - /* Literal.String.Heredoc */ - /* Literal.String.Interpol */ - /* Literal.String.Other */ - /* Literal.String.Regex */ - /* Literal.String.Single */ - /* Literal.String.Symbol */ - /* Name.Builtin.Pseudo */ - /* Name.Variable.Class */ - /* Name.Variable.Global */ - /* Name.Variable.Instance */ - /* Literal.Number.Integer.Long */ } - .highlight .c { - color: #999988; - font-style: italic; } - .highlight .err { - color: #a61717; - background-color: #e3d2d2; } - .highlight .k { - color: #000000; - font-weight: bold; } - .highlight .o { - color: #000000; - font-weight: bold; } - .highlight .cm { - color: #999988; - font-style: italic; } - .highlight .cp { - color: #999999; - font-weight: bold; } - .highlight .c1 { - color: #999988; - font-style: italic; } - .highlight .cs { - color: #999999; - font-weight: bold; - font-style: italic; } - .highlight .gd { - color: #000000; - background-color: #ffdddd; } - .highlight .gd .x { - color: #000000; - background-color: #ffaaaa; } - .highlight .ge { - color: #000000; - font-style: italic; } - .highlight .gr { - color: #aa0000; } - .highlight .gh { - color: #999999; } - .highlight .gi { - color: #000000; - background-color: #ddffdd; } - .highlight .gi .x { - color: #000000; - background-color: #aaffaa; } - .highlight .go { - color: #888888; } - .highlight .gp { - color: #555555; } - .highlight .gs { - font-weight: bold; } - .highlight .gu { - color: #aaaaaa; } - .highlight .gt { - color: #aa0000; } - .highlight .kc { - color: #000000; - font-weight: bold; } - .highlight .kd { - color: #000000; - font-weight: bold; } - .highlight .kp { - color: #000000; - font-weight: bold; } - .highlight .kr { - color: #000000; - font-weight: bold; } - .highlight .kt { - color: #445588; } - .highlight .m { - color: #009999; } - .highlight .s { - color: #d14; } - .highlight .na { - color: #008080; } - .highlight .nb { - color: #0086B3; } - .highlight .nc { - color: #445588; - font-weight: bold; } - .highlight .no { - color: #008080; } - .highlight .ni { - color: #800080; } - .highlight .ne { - color: #990000; - font-weight: bold; } - .highlight .nf { - color: #990000; } - .highlight .nn { - color: #555555; } - .highlight .nt { - color: #000080; } - .highlight .nv { - color: #008080; } - .highlight .ow { - color: #000000; - font-weight: bold; } - .highlight .w { - color: #bbbbbb; } - .highlight .mf { - color: #009999; } - .highlight .mh { - color: #009999; } - .highlight .mi { - color: #009999; } - .highlight .mo { - color: #009999; } - .highlight .sb { - color: #d14; } - .highlight .sc { - color: #d14; } - .highlight .sd { - color: #d14; } - .highlight .s2 { - color: #d14; } - .highlight .se { - color: #d14; } - .highlight .sh { - color: #d14; } - .highlight .si { - color: #d14; } - .highlight .sx { - color: #d14; } - .highlight .sr { - color: #009926; } - .highlight .s1 { - color: #d14; } - .highlight .ss { - color: #990073; } - .highlight .bp { - color: #999999; } - .highlight .vc { - color: #008080; } - .highlight .vg { - color: #008080; } - .highlight .vi { - color: #008080; } - .highlight .il { - color: #009999; } diff --git a/docs/css/jazzy.css b/docs/css/jazzy.css deleted file mode 100644 index 833be0d2..00000000 --- a/docs/css/jazzy.css +++ /dev/null @@ -1,378 +0,0 @@ -*, *:before, *:after { - box-sizing: inherit; } - -body { - margin: 0; - background: #fff; - color: #333; - font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif; - letter-spacing: .2px; - -webkit-font-smoothing: antialiased; - box-sizing: border-box; } - -h1 { - font-size: 2rem; - font-weight: 700; - margin: 1.275em 0 0.6em; } - -h2 { - font-size: 1.75rem; - font-weight: 700; - margin: 1.275em 0 0.3em; } - -h3 { - font-size: 1.5rem; - font-weight: 700; - margin: 1em 0 0.3em; } - -h4 { - font-size: 1.25rem; - font-weight: 700; - margin: 1.275em 0 0.85em; } - -h5 { - font-size: 1rem; - font-weight: 700; - margin: 1.275em 0 0.85em; } - -h6 { - font-size: 1rem; - font-weight: 700; - margin: 1.275em 0 0.85em; - color: #777; } - -p { - margin: 0 0 1em; } - -ul, ol { - padding: 0 0 0 2em; - margin: 0 0 0.85em; } - -blockquote { - margin: 0 0 0.85em; - padding: 0 15px; - color: #858585; - border-left: 4px solid #e5e5e5; } - -img { - max-width: 100%; } - -a { - color: #4183c4; - text-decoration: none; } - a:hover, a:focus { - outline: 0; - text-decoration: underline; } - a.discouraged { - text-decoration: line-through; } - a.discouraged:hover, a.discouraged:focus { - text-decoration: underline line-through; } - -table { - background: #fff; - width: 100%; - border-collapse: collapse; - border-spacing: 0; - overflow: auto; - margin: 0 0 0.85em; } - -tr:nth-child(2n) { - background-color: #fbfbfb; } - -th, td { - padding: 6px 13px; - border: 1px solid #ddd; } - -pre { - margin: 0 0 1.275em; - padding: .85em 1em; - overflow: auto; - background: #f7f7f7; - font-size: .85em; - font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace; } - -code { - font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace; } - -p > code, li > code { - background: #f7f7f7; - padding: .2em; } - p > code:before, p > code:after, li > code:before, li > code:after { - letter-spacing: -.2em; - content: "\00a0"; } - -pre code { - padding: 0; - white-space: pre; } - -.content-wrapper { - display: flex; - flex-direction: column; } - @media (min-width: 768px) { - .content-wrapper { - flex-direction: row; } } - -.header { - display: flex; - padding: 8px; - font-size: 0.875em; - background: #444; - color: #999; } - -.header-col { - margin: 0; - padding: 0 8px; } - -.header-col--primary { - flex: 1; } - -.header-link { - color: #fff; } - -.header-icon { - padding-right: 6px; - vertical-align: -4px; - height: 16px; } - -.breadcrumbs { - font-size: 0.875em; - padding: 8px 16px; - margin: 0; - background: #fbfbfb; - border-bottom: 1px solid #ddd; } - -.carat { - height: 10px; - margin: 0 5px; } - -.navigation { - order: 2; } - @media (min-width: 768px) { - .navigation { - order: 1; - width: 25%; - max-width: 300px; - padding-bottom: 64px; - overflow: hidden; - word-wrap: normal; - background: #fbfbfb; - border-right: 1px solid #ddd; } } - -.nav-groups { - list-style-type: none; - padding-left: 0; } - -.nav-group-name { - border-bottom: 1px solid #ddd; - padding: 8px 0 8px 16px; } - -.nav-group-name-link { - color: #333; } - -.nav-group-tasks { - margin: 8px 0; - padding: 0 0 0 8px; } - -.nav-group-task { - font-size: 1em; - list-style-type: none; - white-space: nowrap; } - -.nav-group-task-link { - color: #808080; } - -.main-content { - order: 1; } - @media (min-width: 768px) { - .main-content { - order: 2; - flex: 1; - padding-bottom: 60px; } } - -.section { - padding: 0 32px; - border-bottom: 1px solid #ddd; } - -.section-content { - max-width: 834px; - margin: 0 auto; - padding: 16px 0; } - -.section-name { - color: #666; - display: block; } - -.declaration .highlight { - overflow-x: initial; - padding: 8px 0; - margin: 0; - background-color: transparent; - border: none; } - -.task-group-section { - border-top: 1px solid #ddd; } - -.task-group { - padding-top: 0px; } - -.task-name-container a[name]:before { - content: ""; - display: block; } - -.item-container { - padding: 0; } - -.item { - padding-top: 8px; - width: 100%; - list-style-type: none; } - .item a[name]:before { - content: ""; - display: block; } - .item .token, .item .direct-link { - padding-left: 3px; - margin-left: 0px; - font-size: 1rem; } - .item .declaration-note { - font-size: .85em; - color: #808080; - font-style: italic; } - -.pointer-container { - border-bottom: 1px solid #ddd; - left: -23px; - padding-bottom: 13px; - position: relative; - width: 110%; } - -.pointer { - left: 21px; - top: 7px; - display: block; - position: absolute; - width: 12px; - height: 12px; - border-left: 1px solid #ddd; - border-top: 1px solid #ddd; - background: #fff; - transform: rotate(45deg); } - -.height-container { - display: none; - position: relative; - width: 100%; - overflow: hidden; } - .height-container .section { - background: #fff; - border: 1px solid #ddd; - border-top-width: 0; - padding-top: 10px; - padding-bottom: 5px; - padding: 8px 16px; } - -.aside, .language { - padding: 6px 12px; - margin: 12px 0; - border-left: 5px solid #dddddd; - overflow-y: hidden; } - .aside .aside-title, .language .aside-title { - font-size: 9px; - letter-spacing: 2px; - text-transform: uppercase; - padding-bottom: 0; - margin: 0; - color: #aaa; - -webkit-user-select: none; } - .aside p:last-child, .language p:last-child { - margin-bottom: 0; } - -.language { - border-left: 5px solid #cde9f4; } - .language .aside-title { - color: #4183c4; } - -.aside-warning, .aside-deprecated, .aside-unavailable { - border-left: 5px solid #ff6666; } - .aside-warning .aside-title, .aside-deprecated .aside-title, .aside-unavailable .aside-title { - color: #ff0000; } - -.graybox { - border-collapse: collapse; - width: 100%; } - .graybox p { - margin: 0; - word-break: break-word; - min-width: 50px; } - .graybox td { - border: 1px solid #ddd; - padding: 5px 25px 5px 10px; - vertical-align: middle; } - .graybox tr td:first-of-type { - text-align: right; - padding: 7px; - vertical-align: top; - word-break: normal; - width: 40px; } - -.slightly-smaller { - font-size: 0.9em; } - -.footer { - padding: 8px 16px; - background: #444; - color: #ddd; - font-size: 0.8em; } - .footer p { - margin: 8px 0; } - .footer a { - color: #fff; } - -html.dash .header, html.dash .breadcrumbs, html.dash .navigation { - display: none; } - -html.dash .height-container { - display: block; } - -form[role=search] input { - font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif; - font-size: 14px; - line-height: 24px; - padding: 0 10px; - margin: 0; - border: none; - border-radius: 1em; } - .loading form[role=search] input { - background: white url(../img/spinner.gif) center right 4px no-repeat; } - -form[role=search] .tt-menu { - margin: 0; - min-width: 300px; - background: #fbfbfb; - color: #333; - border: 1px solid #ddd; } - -form[role=search] .tt-highlight { - font-weight: bold; } - -form[role=search] .tt-suggestion { - font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif; - padding: 0 8px; } - form[role=search] .tt-suggestion span { - display: table-cell; - white-space: nowrap; } - form[role=search] .tt-suggestion .doc-parent-name { - width: 100%; - text-align: right; - font-weight: normal; - font-size: 0.9em; - padding-left: 16px; } - -form[role=search] .tt-suggestion:hover, -form[role=search] .tt-suggestion.tt-cursor { - cursor: pointer; - background-color: #4183c4; - color: #fff; } - -form[role=search] .tt-suggestion:hover .doc-parent-name, -form[role=search] .tt-suggestion.tt-cursor .doc-parent-name { - color: #fff; } diff --git a/docs/docsets/XCoordinator.docset/Contents/Info.plist b/docs/docsets/XCoordinator.docset/Contents/Info.plist deleted file mode 100644 index 35a65c79..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Info.plist +++ /dev/null @@ -1,20 +0,0 @@ - - - - - CFBundleIdentifier - com.jazzy.xcoordinator - CFBundleName - XCoordinator - DocSetPlatformFamily - xcoordinator - isDashDocset - - dashIndexFilePath - index.html - isJavaScriptEnabled - - DashDocSetFamily - dashtoc - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes.html deleted file mode 100644 index fa66b7be..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes.html +++ /dev/null @@ -1,950 +0,0 @@ - - - - Classes Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - Classes Reference -

- -
- -
- -
-
-

Classes

-

The following classes are available globally.

- -
-
- -
-
-
-
    -
  • -
    - - - - Animation - -
    -
    -
    -
    -
    -
    -

    Animation is used to set presentation and dismissal animations for presentables.

    - -

    Depending on the transition in use, different properties of a UIViewController are set to make sure the transition animation is used.

    -
    -

    Note

    -

    To not override the previously set Animation, use nil when initializing a transition.

    - -

    Make sure to hold a strong reference to the Animation object, as it is only held by a weak reference.

    - -
    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open class Animation : NSObject
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - AnyCoordinator - -
    -
    -
    -
    -
    -
    -

    AnyCoordinator is a type-erased Coordinator (RouteType & TransitionType) and -can be used as an abstraction from a specific coordinator class while still specifying -TransitionType and RouteType.

    -
    -

    Note

    - If you do not want/need to specify TransitionType, you might want to look into the -different router abstractions StrongRouter, UnownedRouter and WeakRouter. -See AnyTransitionPerformer to further abstract from RouteType. - -
    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public class AnyCoordinator<RouteType, TransitionType> : Coordinator where RouteType : Route, TransitionType : TransitionProtocol
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • - -
    -
    -
    -
    -
    -

    AnyTransitionPerformer can be used as an abstraction from a specific TransitionPerformer implementation -without losing type information about its TransitionType.

    - -

    This type abstraction can be especially helpful when performing transitions. -AnyTransitionPerformer abstracts away any implementation specific details and reduces coordinators to the capabilities -of the TransitionPerformer protocol.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public class AnyTransitionPerformer<TransitionType> : TransitionPerformer where TransitionType : TransitionProtocol
    - -
    -
    -
    -
    -
    • -
-
-
- -
-
-
    -
  • -
    - - - - BasicCoordinator - -
    -
    -
    -
    -
    -
    -

    BasicCoordinator is a coordinator class that can be used without subclassing.

    - -

    Although subclassing of coordinators is encouraged for more complex cases, a BasicCoordinator can easily -be created by only providing a prepareTransition closure, an initialRoute and an initialLoadingType.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open class BasicCoordinator<RouteType, TransitionType> : BaseCoordinator<RouteType, TransitionType> where RouteType : Route, TransitionType : TransitionProtocol
    - -
    -
    -
    -
    -
    • -
-
-
- -
-
- -
-
-
    -
  • - -
    -
    -
    -
    -
    -

    NavigationAnimationDelegate is used as the delegate of a NavigationCoordinator’s rootViewController -to allow for push-transitions to specify animations.

    - -

    NavigationAnimationDelegate conforms to the UINavigationControllerDelegate protocol -and is intended for use as the delegate of one navigation controller only.

    -
    -

    Note

    - Do not override the delegate of a NavigationCoordinator’s rootViewController. -Instead use the delegate property of the NavigationCoordinator itself. - -
    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open class NavigationAnimationDelegate : NSObject
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - NavigationCoordinator - -
    -
    -
    -
    -
    -
    -

    NavigationCoordinator acts as a base class for custom coordinators with a UINavigationController -as rootViewController.

    - -

    NavigationCoordinator especially ensures that transition animations are called, -which would not be the case when creating a BaseCoordinator<RouteType, NavigationTransition>.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open class NavigationCoordinator<RouteType> : BaseCoordinator<RouteType, NavigationTransition> where RouteType : Route
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - PageCoordinator - -
    -
    -
    -
    -
    -
    -

    PageCoordinator provides a base class for your custom coordinator with a UIPageViewController rootViewController.

    -
    -

    Note

    - PageCoordinator sets the dataSource of the rootViewController to reflect the parameters in the initializer. - -
    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open class PageCoordinator<RouteType> : BaseCoordinator<RouteType, PageTransition> where RouteType : Route
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • - -
    -
    -
    -
    -
    -

    PageCoordinatorDataSource is a -UIPageViewControllerDataSource -implementation with a rather static list of pages.

    - -

    It further allows looping through the given pages. When looping is active the pages are wrapped around in the given presentables array. -When the user navigates beyond the end of the specified pages, the pages are wrapped around by displaying the first page. -In analogy to that, it also wraps to the last page when navigating beyond the beginning.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open class PageCoordinatorDataSource : NSObject, UIPageViewControllerDataSource
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - RedirectionRouter - -
    -
    -
    -
    -
    -
    -

    RedirectionRouters can be used to extract routes into different route types. -Instead of having one huge route and one or more huge coordinators, you can create separate redirecting routers.

    - -

    Create a RedirectionRouter from a parent router by providing a reference to that parent. -Triggered routes of the RedirectionRouter will be redirected to this parent router according to the provided mapping. -Please provide either a map closure in the initializer or override the mapToParentRoute method.

    - -

    A RedirectionRouter has a viewController which is used in transitions, -e.g. when you are presenting, pushing, or otherwise displaying it.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open class RedirectionRouter<ParentRoute, RouteType> : Router where ParentRoute : Route, RouteType : Route
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - SplitCoordinator - -
    -
    -
    -
    -
    -
    -

    SplitCoordinator can be used as a basis for a coordinator with a rootViewController of type -UISplitViewController.

    - -

    You can use all SplitTransitions and get an initializer to set a master and -(optional) detail presentable.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open class SplitCoordinator<RouteType> : BaseCoordinator<RouteType, SplitTransition> where RouteType : Route
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • - -
    -
    -
    -
    -
    -

    StaticTransitionAnimation can be used to realize static transition animations.

    -
    -

    Note

    - Consider using InteractiveTransitionAnimation instead, if possible, as it is as simple -to use. However, this class is helpful to make sure your transition animation is not mistaken to be -interactive, if your animation code does not fulfill the requirements of an interactive transition -animation. - -
    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open class StaticTransitionAnimation : NSObject, TransitionAnimation
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - StrongRouter - -
    -
    -
    -
    -
    -
    -

    StrongRouter is a type-erasure of a given Router object and, therefore, can be used as an abstraction from a specific Router -implementation without losing type information about its RouteType.

    - -

    StrongRouter abstracts away any implementation specific details and -essentially reduces them to properties specified in the Router protocol.

    -
    -

    Note

    - Do not hold a reference to any router from the view hierarchy. -Use UnownedRouter or WeakRouter in your view controllers or view models instead. -You can create them using the Coordinator.unownedRouter and Coordinator.weakRouter properties. - -
    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public final class StrongRouter<RouteType> : Router where RouteType : Route
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • - -
    -
    -
    -
    -
    -

    TabBarAnimationDelegate is used as the delegate of a TabBarCoordinator’s rootViewController -to allow for transitions to specify transition animations.

    - -

    TabBarAnimationDelegate conforms to the UITabBarControllerDelegate protocol -and is intended for use as the delegate of one tabbar controller only.

    -
    -

    Note

    - Do not override the delegate of a TabBarCoordinator’s rootViewController-delegate. -Instead use the delegate property of the TabBarCoordinator itself. - -
    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open class TabBarAnimationDelegate : NSObject
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - TabBarCoordinator - -
    -
    -
    -
    -
    -
    -

    Use a TabBarCoordinator to coordinate a flow where a UITabbarController serves as a rootViewController. -With a TabBarCoordinator, you get access to all tabbarController-related transitions.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open class TabBarCoordinator<RouteType> : BaseCoordinator<RouteType, TabBarTransition> where RouteType : Route
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - ViewCoordinator - -
    -
    -
    -
    -
    -
    -

    ViewCoordinator is a base class for custom coordinators with a UIViewController rootViewController.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open class ViewCoordinator<RouteType> : BaseCoordinator<RouteType, ViewTransition> where RouteType : Route
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/Animation.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/Animation.html deleted file mode 100644 index 9950c0b3..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/Animation.html +++ /dev/null @@ -1,698 +0,0 @@ - - - - Animation Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - Animation Class Reference -

- -
- -
- -
-
-

Animation

-
-
- 
open class Animation : NSObject
- -
-
-

Animation is used to set presentation and dismissal animations for presentables.

- -

Depending on the transition in use, different properties of a UIViewController are set to make sure the transition animation is used.

-
-

Note

-

To not override the previously set Animation, use nil when initializing a transition.

- -

Make sure to hold a strong reference to the Animation object, as it is only held by a weak reference.

- -
- -
-
- -
-
-
-
- - - -

Static properties

- -
-
    -
  • -
    - - - - default - -
    -
    -
    -
    -
    -
    -

    Use Animation.default to override currently set animations -and reset to the default animations provided by iOS

    -
    -

    Note

    - To disable animations make sure to use non-animating TransitionOptions when triggering. - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static let `default`: Animation
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Stored properties

- -
-
    -
  • -
    - - - - presentationAnimation - -
    -
    -
    -
    -
    -
    -

    The transition animation performed when transitioning to a presentable.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open var presentationAnimation: TransitionAnimation?
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - dismissalAnimation - -
    -
    -
    -
    -
    -
    -

    The transition animation performed when transitioning away from a presentable.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open var dismissalAnimation: TransitionAnimation?
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Initialization

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Creates an Animation object containing a presentation and a dismissal animation.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(presentation: TransitionAnimation?, dismissal: TransitionAnimation?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - presentation - - -
    -

    The transition animation performed when transitioning to a presentable.

    -
    -
    - - dismissal - - -
    -

    The transition animation performed when transitioning away from a presentable.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

UIViewControllerTransitioningDelegate

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    See UIViewControllerTransitioningDelegate -for further reference.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func animationController(forPresented presented: UIViewController,
-                              presenting: UIViewController,
-                              source: UIViewController) -> UIViewControllerAnimatedTransitioning?
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - presented - - -
    -

    The view controller to be presented.

    -
    -
    - - presenting - - -
    -

    The view controller that is presenting.

    -
    -
    - - source - - -
    -

    The view controller whose present(_:animated:completion:) was called.

    -
    -
    -
    -
    -

    Return Value

    -

    The presentation animation when initializing the Animation object.

    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UIViewControllerTransitioningDelegate -for further reference.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func animationController(forDismissed dismissed: UIViewController) -> UIViewControllerAnimatedTransitioning?
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - dismissed - - -
    -

    The view controller to be dismissed.

    -
    -
    -
    -
    -

    Return Value

    -

    The dismissal animation when initializing the Animation object.

    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UIViewControllerTransitioningDelegate -for further reference.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func interactionControllerForPresentation(using animator: UIViewControllerAnimatedTransitioning)
-    -> UIViewControllerInteractiveTransitioning?
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - animator - - -
    -

    The animator of this transition, which is most likely the presentation animation.

    -
    -
    -
    -
    -

    Return Value

    -

    The presentation animation’s interaction controller.

    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UIViewControllerTransitioningDelegate -for further reference.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func interactionControllerForDismissal(using animator: UIViewControllerAnimatedTransitioning)
-    -> UIViewControllerInteractiveTransitioning?
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - animator - - -
    -

    The animator of this transition, which is most likely the dismissal animation.

    -
    -
    -
    -
    -

    Return Value

    -

    The dismissal animation’s interaction controller.

    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/AnyCoordinator.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/AnyCoordinator.html deleted file mode 100644 index 325ac30c..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/AnyCoordinator.html +++ /dev/null @@ -1,616 +0,0 @@ - - - - AnyCoordinator Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - AnyCoordinator Class Reference -

- -
- -
- -
-
-

AnyCoordinator

-
-
- 
public class AnyCoordinator<RouteType, TransitionType> : Coordinator where RouteType : Route, TransitionType : TransitionProtocol
- -
-
-

AnyCoordinator is a type-erased Coordinator (RouteType & TransitionType) and -can be used as an abstraction from a specific coordinator class while still specifying -TransitionType and RouteType.

-
-

Note

- If you do not want/need to specify TransitionType, you might want to look into the -different router abstractions StrongRouter, UnownedRouter and WeakRouter. -See AnyTransitionPerformer to further abstract from RouteType. - -
- -
-
- -
-
-
-
- - - -

Initialization

- -
-
    -
  • -
    - - - - init(_:) - -
    -
    -
    -
    -
    -
    -

    Creates a type-erased Coordinator for a specific coordinator.

    - -

    A strong reference to the source coordinator is kept.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init<C>(_ coordinator: C) where RouteType == C.RouteType, TransitionType == C.TransitionType, C : Coordinator
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - coordinator - - -
    -

    The source coordinator.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Computed properties

- -
-
    -
  • -
    - - - - rootViewController - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var rootViewController: TransitionType.RootViewController { get }
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - viewController - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var viewController: UIViewController! { get }
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Methods

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Prepare and return transitions for a given route.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func prepareTransition(for route: RouteType) -> TransitionType
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - route - - -
    -

    The triggered route for which a transition is to be prepared.

    -
    -
    -
    -
    -

    Return Value

    -

    The prepared transition.

    -
    -
    -
    -
    • -
  • -
    - - - - presented(from:) - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func presented(from presentable: Presentable?)
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - registerParent(_:) - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func registerParent(_ presentable: Presentable & AnyObject)
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - setRoot(for:) - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func setRoot(for window: UIWindow)
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - addChild(_:) - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func addChild(_ presentable: Presentable)
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - removeChild(_:) - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func removeChild(_ presentable: Presentable)
    - -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func removeChildrenIfNeeded()
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/AnyTransitionPerformer.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/AnyTransitionPerformer.html deleted file mode 100644 index 2cf62098..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/AnyTransitionPerformer.html +++ /dev/null @@ -1,401 +0,0 @@ - - - - AnyTransitionPerformer Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - AnyTransitionPerformer Class Reference -

- -
- -
- -
-
-

AnyTransitionPerformer

-
-
- 
public class AnyTransitionPerformer<TransitionType> : TransitionPerformer where TransitionType : TransitionProtocol
- -
-
-

AnyTransitionPerformer can be used as an abstraction from a specific TransitionPerformer implementation -without losing type information about its TransitionType.

- -

This type abstraction can be especially helpful when performing transitions. -AnyTransitionPerformer abstracts away any implementation specific details and reduces coordinators to the capabilities -of the TransitionPerformer protocol.

- -
-
- -
-
-
-
- - - -

Computed properties

- -
-
    -
  • -
    - - - - viewController - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var viewController: UIViewController! { get }
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - rootViewController - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var rootViewController: TransitionType.RootViewController { get }
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Methods

- -
- -
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/BaseCoordinator.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/BaseCoordinator.html deleted file mode 100644 index a6b17b78..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/BaseCoordinator.html +++ /dev/null @@ -1,1007 +0,0 @@ - - - - BaseCoordinator Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - BaseCoordinator Class Reference -

- -
- -
- -
-
-

BaseCoordinator

-
-
- 
open class BaseCoordinator<RouteType, TransitionType> : Coordinator where RouteType : Route, TransitionType : TransitionProtocol
- -
-
-

BaseCoordinator can (and is encouraged to) be used as a superclass for any custom implementation of a coordinator.

- -

It is also encouraged to use already provided subclasses of BaseCoordinator such as -NavigationCoordinator, TabBarCoordinator, ViewCoordinator, SplitCoordinator -and PageCoordinator.

- -
-
- -
-
-
-
- - - -

Stored properties

- -
-
    -
  • -
    - - - - children - -
    -
    -
    -
    -
    -
    -

    The child coordinators that are currently in the view hierarchy. -When performing a transition, children are automatically added and removed from this array -depending on whether they are in the view hierarchy.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public private(set) var children: [Presentable]
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Computed properties

- -
-
    -
  • -
    - - - - rootViewController - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public private(set) var rootViewController: RootViewController
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - viewController - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var viewController: UIViewController! { get }
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Initialization

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    This initializer trigger a route before the coordinator is made visible.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(rootViewController: RootViewController, initialRoute: RouteType?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - initialRoute - - -
    -

    If a route is specified, it is triggered before making the coordinator visible.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    This initializer performs a transition before the coordinator is made visible.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(rootViewController: RootViewController, initialTransition: TransitionType?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - initialTransition - - -
    -

    If a transition is specified, it is performed before making the coordinator visible.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Open methods

- -
-
    -
  • -
    - - - - presented(from:) - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func presented(from presentable: Presentable?)
    - -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func removeChildrenIfNeeded()
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - addChild(_:) - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func addChild(_ presentable: Presentable)
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - removeChild(_:) - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func removeChild(_ presentable: Presentable)
    - -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    This method prepares transitions for routes. -Override this method to define transitions for triggered routes.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func prepareTransition(for route: RouteType) -> TransitionType
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - route - - -
    -

    The triggered route for which a transition is to be prepared.

    -
    -
    -
    -
    -

    Return Value

    -

    The prepared transition.

    -
    -
    -
    -
    • -
  • -
    - - - - registerParent(_:) - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func registerParent(_ presentable: Presentable & AnyObject)
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - RootViewController - -
    -
    -
    -
    -
    -
    -

    Shortcut for BaseCoordinator.TransitionType.RootViewController

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public typealias RootViewController = TransitionType.RootViewController
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Registering

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Register an interactive transition triggered by a gesture recognizer.

    - -

    Also consider registerInteractiveTransition(for:triggeredBy:progress:shouldFinish:completion:) as it might make it easier -to implement an interactive transition. This is meant for cases where the other method does not provide enough customization -options.

    - -

    A target is added to the gestureRecognizer so that the handler is executed every time the state of the gesture recognizer changes.

    -
    -

    Note

    -

    Use unregisterInteractiveTransition(triggeredBy:) to remove previously added interactive transitions.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func registerInteractiveTransition<GestureRecognizer: UIGestureRecognizer>(
-    for route: RouteType,
-    triggeredBy recognizer: GestureRecognizer,
-    handler: @escaping (_ handlerRecognizer: GestureRecognizer, _ transition: () -> TransitionAnimation?) -> Void,
-    completion: PresentationHandler? = nil)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - route - - -
    -

    The route to be triggered when the gestureRecognizer begins. -Make sure that the transition behind is interactive as otherwise the transition is simply performed.

    -
    -
    - - recognizer - - -
    -

    The gesture recognizer to be used to update the interactive transition.

    -
    -
    - - handler - - -
    -

    The handler to update the interaction controller of the animation generated by the given transition closure.

    -
    -
    - - handlerRecognizer - - -
    -

    The gestureRecognizer with which the handler has been registered.

    -
    -
    - - transition - - -
    -

    The closure to perform the transition. It returns the transition animation to control the interaction controller of. -TransitionAnimation.start() is automatically called.

    -
    -
    - - completion - - -
    -

    The closure to be called whenever the transition completes. -Hint: Might be called multiple times but only once per performing the transition.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Register an interactive transition triggered by a gesture recognizer.

    - -

    To get more customization options, check out registerInteractiveTransition(for:triggeredBy:handler:completion:).

    - -

    A target is added to the gestureRecognizer so that the handler is executed every time the state of the gesture recognizer changes.

    -
    -

    Note

    -

    Use unregisterInteractiveTransition(triggeredBy:) to remove previously added interactive transitions.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func registerInteractiveTransition<GestureRecognizer: UIGestureRecognizer>(
-    for route: RouteType,
-    triggeredBy recognizer: GestureRecognizer,
-    progress: @escaping (GestureRecognizer) -> CGFloat,
-    shouldFinish: @escaping (GestureRecognizer) -> Bool,
-    completion: PresentationHandler? = nil)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - - - - - - - - - -
    - - route - - -
    -

    The route to be triggered when the gestureRecognizer begins. -Make sure that the transition behind is interactive as otherwise the transition is simply performed.

    -
    -
    - - recognizer - - -
    -

    The gesture recognizer to be used to update the interactive transition.

    -
    -
    - - progress - - -
    -

    Return the progress as CGFloat between 0 (start) and 1 (finish).

    -
    -
    - - shouldFinish - - -
    -

    Decide depending on the gestureRecognizer’s state whether to finish or cancel a given transition.

    -
    -
    - - completion - - -
    -

    The closure to be called whenever the transition completes. -Hint: Might be called multiple times but only once per performing the transition.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Unregistering

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Unregisters a previously registered interactive transition.

    - -

    Unregistering is not mandatory to prevent reference cycles, etc. -It is useful, though, to remove previously registered interactive transitions that are no longer needed or wanted.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func unregisterInteractiveTransitions(triggeredBy recognizer: UIGestureRecognizer)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - recognizer - - -
    -

    The recognizer to unregister interactive transitions for. -This method will unregister all interactive transitions with that gesture recognizer.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/BasicCoordinator.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/BasicCoordinator.html deleted file mode 100644 index 56246807..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/BasicCoordinator.html +++ /dev/null @@ -1,487 +0,0 @@ - - - - BasicCoordinator Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - BasicCoordinator Class Reference -

- -
- -
- -
-
-

BasicCoordinator

-
-
- 
open class BasicCoordinator<RouteType, TransitionType> : BaseCoordinator<RouteType, TransitionType> where RouteType : Route, TransitionType : TransitionProtocol
- -
-
-

BasicCoordinator is a coordinator class that can be used without subclassing.

- -

Although subclassing of coordinators is encouraged for more complex cases, a BasicCoordinator can easily -be created by only providing a prepareTransition closure, an initialRoute and an initialLoadingType.

- -
-
- -
-
-
-
- - - -

Nested types

- -
-
    -
  • -
    - - - - InitialLoadingType - -
    -
    -
    -
    -
    -
    -

    InitialLoadingType differentiates between different points in time when the initital route is to -be triggered by the coordinator.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public enum InitialLoadingType
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Initialization

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Creates a BasicCoordinator.

    -
    -

    Seealso

    -

    See InitialLoadingType for more information.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(rootViewController: RootViewController,
-            initialRoute: RouteType? = nil,
-            initialLoadingType: InitialLoadingType = .presented,
-            prepareTransition: ((RouteType) -> TransitionType)?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - initialRoute - - -
    -

    If a route is specified, it is triggered depending on the initialLoadingType.

    -
    -
    - - initialLoadingType - - -
    -

    The initialLoadingType specifies when the initialRoute is triggered.

    -
    -
    - - prepareTransition - - -
    -

    A closure to define transitions based on triggered routes. -Make sure to override prepareTransition by subclassing, if you specify nil here.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Open methods

- -
-
    -
  • -
    - - - - presented(from:) - -
    -
    -
    -
    -
    -
    -

    This method is called whenever the BasicCoordinator is shown to the user.

    - -

    If initialLoadingType has been specified as presented and an initialRoute is present, -the route is triggered here.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open override func presented(from presentable: Presentable?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - presentable - - -
    -

    The context in which this coordinator has been shown to the user.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open override func prepareTransition(for route: RouteType) -> TransitionType
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/BasicCoordinator/InitialLoadingType.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/BasicCoordinator/InitialLoadingType.html deleted file mode 100644 index b25611d2..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/BasicCoordinator/InitialLoadingType.html +++ /dev/null @@ -1,327 +0,0 @@ - - - - InitialLoadingType Enumeration Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - InitialLoadingType Enumeration Reference -

- -
- -
- -
-
-

InitialLoadingType

-
-
- 
public enum InitialLoadingType
- -
-
-

InitialLoadingType differentiates between different points in time when the initital route is to -be triggered by the coordinator.

- -
-
- -
-
-
-
    -
  • -
    - - - - immediately - -
    -
    -
    -
    -
    -
    -

    The initial route is triggered before the coordinator is made visible (i.e. on initialization).

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    case immediately
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - presented - -
    -
    -
    -
    -
    -
    -

    The initial route is triggered after the coordinator is made visible.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    case presented
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/InteractiveTransitionAnimation.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/InteractiveTransitionAnimation.html deleted file mode 100644 index 4df724ac..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/InteractiveTransitionAnimation.html +++ /dev/null @@ -1,735 +0,0 @@ - - - - InteractiveTransitionAnimation Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - InteractiveTransitionAnimation Class Reference -

- -
- -
- -
-
-

InteractiveTransitionAnimation

-
-
- 
open class InteractiveTransitionAnimation : NSObject, TransitionAnimation
- -
-
-

InteractiveTransitionAnimation provides a simple interface to create interactive transition animations.

- -

An InteractiveTransitionAnimation can be created by providing the duration, the animation code -and (optionally) a closure to create an interaction controller.

-
-

Note

- To get further information read the UIKit documentation of -UIViewControllerAnimatedTransitioning, -UIViewControllerInteractiveTransitioning, -UIViewControllerContextTransitioning and -UIPercentDrivenInteractiveTransition. - -
- -
-
- -
-
-
-
- - - -

Computed properties

- -
- -
-
-
- - - -

Initialization

- -
- -
-
-
- - - -

Methods

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    See UIViewControllerAnimatedTransitioning -for further information.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func transitionDuration(using transitionContext: UIViewControllerContextTransitioning?) -> TimeInterval
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - transitionContext - - -
    -

    The context of the transition.

    -
    -
    -
    -
    -

    Return Value

    -

    The transition duration as specified in the initializer.

    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UIViewControllerAnimatedTransitioning -for further information.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func animateTransition(using transitionContext: UIViewControllerContextTransitioning)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - transitionContext - - -
    -

    The context of a transition for which the animation should be started.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

TransitionAnimation

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    This method is used to generate an applicable interaction controller.

    -
    -

    Note

    - To allow for more complex logic to create a specific interaction controller, -override this method in your subclass. - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func generateInteractionController() -> PercentDrivenInteractionController?
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - start() - -
    -
    -
    -
    -
    -
    -

    Starts the transition animation by generating an interaction controller.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func start()
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - cleanup() - -
    -
    -
    -
    -
    -
    -

    Ends the transition animation by deleting the interaction controller.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func cleanup()
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/InterruptibleTransitionAnimation.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/InterruptibleTransitionAnimation.html deleted file mode 100644 index 19f3c114..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/InterruptibleTransitionAnimation.html +++ /dev/null @@ -1,589 +0,0 @@ - - - - InterruptibleTransitionAnimation Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - InterruptibleTransitionAnimation Class Reference -

- -
- -
- -
-
-

InterruptibleTransitionAnimation

-
-
- 
@available(iOS 10.0, *)
-open class InterruptibleTransitionAnimation : InteractiveTransitionAnimation
- -
-
-

Use InterruptibleTransitionAnimation to define interactive transitions based on the -UIViewPropertyAnimator -APIs introduced in iOS 10.

- -
-
- -
-
-
-
- - - -

Initialization

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Creates an interruptible transition animation based on duration, an animator generator closure -and an interaction controller generator closure.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(duration: TimeInterval,
-            generateAnimator: @escaping (UIViewControllerContextTransitioning) -> UIViewImplicitlyAnimating,
-            generateInteractionController: @escaping () -> PercentDrivenInteractionController?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - duration - - -
    -

    The total duration of the animation.

    -
    -
    - - generateAnimator - - -
    -

    A generator closure to create a UIViewPropertyAnimator dynamically.

    -
    -
    - - generateInteractionController - - -
    -

    A generator closure to create an interaction controller which handles animation progress changes.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Creates an interruptible transition animation based on duration and an animator generator closure.

    - -

    A UIPercentDrivenInteractiveTransition is used as interaction controller.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public convenience init(duration: TimeInterval,
-                        generateAnimator: @escaping (UIViewControllerContextTransitioning) -> UIViewImplicitlyAnimating)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - duration - - -
    -

    The total duration of the animation.

    -
    -
    - - generateAnimator - - -
    -

    A generator closure to create a UIViewPropertyAnimator dynamically.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Methods

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Generates an interruptible animator based on the transitionContext. -It further adds a completion block to the animator to ensure it is deallocated once -the transition is finished.

    - -

    This code is called once per transition to generate the interruptible animator -which is reused in subsequent calls of interruptibeAnimator(using:).

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func generateInterruptibleAnimator(using transitionContext: UIViewControllerContextTransitioning) -> UIViewImplicitlyAnimating
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - transitionContext - - -
    -

    The context in which the transition is performed.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

TransitionAnimation

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    See UIViewControllerAnimatedTransitioning -for further information.

    - -

    This method simply calls startAnimation() on the interruptible animator.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open override func animateTransition(using transitionContext: UIViewControllerContextTransitioning)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - transitionContext - - -
    -

    The context in which the transition is performed.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UIViewControllerAnimatedTransitioning -for further information.

    - -

    This method returns an already generated interruptible animator, if present. -Otherwise it generates a new one using generateInterruptibleAnimator(using:).

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func interruptibleAnimator(using transitionContext: UIViewControllerContextTransitioning
-    ) -> UIViewImplicitlyAnimating
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - transitionContext - - -
    -

    The context in which the transition is performed.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/NavigationAnimationDelegate.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/NavigationAnimationDelegate.html deleted file mode 100644 index 88d98297..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/NavigationAnimationDelegate.html +++ /dev/null @@ -1,855 +0,0 @@ - - - - NavigationAnimationDelegate Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - NavigationAnimationDelegate Class Reference -

- -
- -
- -
-
-

NavigationAnimationDelegate

-
-
- 
open class NavigationAnimationDelegate : NSObject
- -
-
-

NavigationAnimationDelegate is used as the delegate of a NavigationCoordinator’s rootViewController -to allow for push-transitions to specify animations.

- -

NavigationAnimationDelegate conforms to the UINavigationControllerDelegate protocol -and is intended for use as the delegate of one navigation controller only.

-
-

Note

- Do not override the delegate of a NavigationCoordinator’s rootViewController. -Instead use the delegate property of the NavigationCoordinator itself. - -
- -
-
- -
-
-
-
- - - -

Stored properties

- -
-
    -
  • -
    - - - - velocityThreshold - -
    -
    -
    -
    -
    -
    -

    The velocity threshold needed for the interactive pop transition to succeed

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open var velocityThreshold: CGFloat { get }
    - -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    The transition progress threshold for the interactive pop transition to succeed

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open var transitionProgressThreshold: CGFloat { get }
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

UINavigationControllerDelegate

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    See UINavigationControllerDelegate documentation -for further reference.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func navigationController(_ navigationController: UINavigationController,
-                               interactionControllerFor animationController: UIViewControllerAnimatedTransitioning
-    ) -> UIViewControllerInteractiveTransitioning?
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - navigationController - - -
    -

    The delegate owner.

    -
    -
    - - animationController - - -
    -

    The animationController to return the interactionController for.

    -
    -
    -
    -
    -

    Return Value

    -

    If the animationController is a TransitionAnimation, it returns its interactionController. -Otherwise it requests an interactionController from the NavigationCoordinator’s delegate.

    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UINavigationControllerDelegate documentation -for further reference.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func navigationController(_ navigationController: UINavigationController,
-                               animationControllerFor operation: UINavigationController.Operation,
-                               from fromVC: UIViewController,
-                               to toVC: UIViewController) -> UIViewControllerAnimatedTransitioning?
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - - - - - -
    - - navigationController - - -
    -

    The delegate owner.

    -
    -
    - - operation - - -
    -

    The operation being executed. Possible values are push, pop or none.

    -
    -
    - - fromVC - - -
    -

    The source view controller of the transition.

    -
    -
    - - toVC - - -
    -

    The destination view controller of the transition.

    -
    -
    -
    -
    -

    Return Value

    -

    The destination view controller’s animationController depending on its transitioningDelegate. -In the case of a push operation, it returns the toVC’s presentation animation. -For pop it is the fromVC’s dismissal animation. If there is no transitioningDelegate or the operation none is used, -it uses the NavigationCoordinator’s delegate as fallback.

    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UINavigationControllerDelegate documentation -for further reference.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func navigationController(_ navigationController: UINavigationController,
-                               didShow viewController: UIViewController, animated: Bool)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - navigationController - - -
    -

    The delegate owner.

    -
    -
    - - operation - - -
    -

    The operation being executed. Possible values are push, pop or none.

    -
    -
    - - viewController - - -
    -

    The target view controller.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UINavigationControllerDelegate documentation -for further reference.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func navigationController(_ navigationController: UINavigationController,
-                               willShow viewController: UIViewController,
-                               animated: Bool)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - navigationController - - -
    -

    The delegate owner.

    -
    -
    - - operation - - -
    -

    The operation being executed. Possible values are push, pop or none.

    -
    -
    - - viewController - - -
    -

    The view controller to be shown.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Delegate methods

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    See UIGestureRecognizerDelegate documentation -for further reference.

    -
    -

    Note

    -

    This method alters the target of the gestureRecognizer to either its former delegate (UIKit default) -or this class depending on whether a pop animation has been specified.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func gestureRecognizerShouldBegin(_ gestureRecognizer: UIGestureRecognizer) -> Bool
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - gestureRecognizer - - -
    -

    The gesture recognizer this class is the delegate of. -This class is used as the delegate for the interactivePopGestureRecognizer of -the navigationController.

    -
    -
    -
    -
    -

    Return Value

    -

    This method returns true, if and only if

    - -
      -
    • there are more than 1 view controllers on the navigation controller stack (so that it is possible to pop a viewController) and
      • -
    • it is the interactivePopGestureRecognizer to call this method
      • -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Target actions

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    This method handles changes of the navigation controller’s interactivePopGestureRecognizer.

    - -

    This method performs the top-most dismissalAnimation and informs its interaction controller about changes -of the interactivePopGestureRecognizer’s state.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    @objc
-open func handleInteractivePopGestureRecognizer(_ gestureRecognizer: UIGestureRecognizer)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - gestureRecognizer - - -
    -

    The interactivePopGestureRecognizer of the UINavigationController.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Helpers

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    This method sets up the interactivePopGestureRecognizer of the navigation controller -to allow for custom interactive pop animations.

    - -

    This method overrides the delegate of the interactivePopGestureRecognizer to self, -but keeps a reference to the original delegate to enable the default pop animations.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func setupPopGestureRecognizer(for navigationController: UINavigationController)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - navigationController - - -
    -

    The navigation controller to be set up.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/NavigationCoordinator.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/NavigationCoordinator.html deleted file mode 100644 index 7ff05792..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/NavigationCoordinator.html +++ /dev/null @@ -1,458 +0,0 @@ - - - - NavigationCoordinator Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - NavigationCoordinator Class Reference -

- -
- -
- -
-
-

NavigationCoordinator

-
-
- 
open class NavigationCoordinator<RouteType> : BaseCoordinator<RouteType, NavigationTransition> where RouteType : Route
- -
-
-

NavigationCoordinator acts as a base class for custom coordinators with a UINavigationController -as rootViewController.

- -

NavigationCoordinator especially ensures that transition animations are called, -which would not be the case when creating a BaseCoordinator<RouteType, NavigationTransition>.

- -
-
- -
-
-
-
- - - -

Stored properties

- -
-
    -
  • -
    - - - - animationDelegate - -
    -
    -
    -
    -
    -
    -

    The animation delegate controlling the rootViewController’s transition animations. -This animation delegate is set to be the rootViewController’s rootViewController, if you did not set one earlier.

    -
    -

    Note

    - Use the delegate property to set a custom delegate and use transition animations provided by XCoordinator. - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public let animationDelegate: NavigationAnimationDelegate
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Computed properties

- -
-
    -
  • -
    - - - - delegate - -
    -
    -
    -
    -
    -
    -

    This represents a fallback-delegate to be notified about navigation controller events. -It is further used to call animation methods when no animation has been specified in the transition.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var delegate: UINavigationControllerDelegate? { get set }
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Initialization

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Creates a NavigationCoordinator and optionally triggers an initial route.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public override init(rootViewController: RootViewController = .init(), initialRoute: RouteType? = nil)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - initialRoute - - -
    -

    The route to be triggered.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Creates a NavigationCoordinator and pushes a presentable onto the navigation stack right away.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(rootViewController: RootViewController = .init(), root: Presentable)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - root - - -
    -

    The presentable to be pushed.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/PageCoordinator.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/PageCoordinator.html deleted file mode 100644 index 16b56db4..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/PageCoordinator.html +++ /dev/null @@ -1,525 +0,0 @@ - - - - PageCoordinator Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - PageCoordinator Class Reference -

- -
- -
- -
-
-

PageCoordinator

-
-
- 
open class PageCoordinator<RouteType> : BaseCoordinator<RouteType, PageTransition> where RouteType : Route
- -
-
-

PageCoordinator provides a base class for your custom coordinator with a UIPageViewController rootViewController.

-
-

Note

- PageCoordinator sets the dataSource of the rootViewController to reflect the parameters in the initializer. - -
- -
-
- -
-
-
-
- - - -

Stored properties

- -
-
    -
  • -
    - - - - dataSource - -
    -
    -
    -
    -
    -
    -

    The dataSource of the rootViewController.

    - -

    Feel free to change the pages at runtime. To reflect the changes in the rootViewController, perform a set transition as well.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public let dataSource: UIPageViewControllerDataSource
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Initialization

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Creates a PageCoordinator with several sequential (potentially looping) pages.

    - -

    It further sets the current page of the rootViewController animated in the specified direction.

    -
    -

    Note

    -

    If you need custom configuration of the rootViewController, modify the configuration parameter, -since you cannot change this after the initialization.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(rootViewController: RootViewController = .init(),
-            pages: [Presentable],
-            loop: Bool = false,
-            set: Presentable? = nil,
-            direction: UIPageViewController.NavigationDirection = .forward)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - - - - - - - - - -
    - - pages - - -
    -

    The pages of the PageCoordinator. -These can be changed later, if necessary, using the PageCoordinator.dataSource property.

    -
    -
    - - loop - - -
    -

    Whether or not the PageCoordinator should loop when hitting the end or the beginning of the specified pages.

    -
    -
    - - set - - -
    -

    The presentable to be shown right from the start. -This should be one of the elements of the specified pages. -If not specified, no set transition is triggered, which results in the first page being shown.

    -
    -
    - - direction - - -
    -

    The direction in which the transition to set the specified first page (parameter set) should be animated in. -If you specify nil for set, this parameter is ignored.

    -
    -
    - - configuration - - -
    -

    The configuration of the rootViewController. You cannot change this configuration later anymore (Limitation of UIKit).

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Creates a PageCoordinator with a custom dataSource. -It further sets the currently shown page and a direction for the animation of displaying it. -If you need custom configuration of the rootViewController, modify the configuration parameter, -since you cannot change this after the initialization.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(rootViewController: RootViewController = .init(),
-            dataSource: UIPageViewControllerDataSource,
-            set: Presentable,
-            direction: UIPageViewController.NavigationDirection)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - - - - - -
    - - dataSource - - -
    -

    The dataSource of the PageCoordinator.

    -
    -
    - - set - - -
    -

    The presentable to be shown right from the start. -This should be one of the elements of the specified pages. -If not specified, no set transition is triggered, which results in the first page being shown.

    -
    -
    - - direction - - -
    -

    The direction in which the transition to set the specified first page (parameter set) should be animated in. -If you specify nil for set, this parameter is ignored.

    -
    -
    - - configuration - - -
    -

    The configuration of the rootViewController. You cannot change this configuration later anymore (Limitation of UIKit).

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/PageCoordinatorDataSource.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/PageCoordinatorDataSource.html deleted file mode 100644 index e6e8c8c3..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/PageCoordinatorDataSource.html +++ /dev/null @@ -1,660 +0,0 @@ - - - - PageCoordinatorDataSource Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - PageCoordinatorDataSource Class Reference -

- -
- -
- -
-
-

PageCoordinatorDataSource

-
-
- 
open class PageCoordinatorDataSource : NSObject, UIPageViewControllerDataSource
- -
-
-

PageCoordinatorDataSource is a -UIPageViewControllerDataSource -implementation with a rather static list of pages.

- -

It further allows looping through the given pages. When looping is active the pages are wrapped around in the given presentables array. -When the user navigates beyond the end of the specified pages, the pages are wrapped around by displaying the first page. -In analogy to that, it also wraps to the last page when navigating beyond the beginning.

- -
-
- -
-
-
-
- - - -

Stored properties

- -
-
    -
  • -
    - - - - pages - -
    -
    -
    -
    -
    -
    -

    The pages of the UIPageViewController in sequential order.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open var pages: [UIViewController]
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - loop - -
    -
    -
    -
    -
    -
    -

    Whether or not the pages of the UIPageViewController should be in a loop, -i.e. whether a swipe to the left of the last page should result in the first page being shown -(or the last shown when swiping right on the first page)

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open var loop: Bool
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Initialization

- -
-
    -
  • -
    - - - - init(pages:loop:) - -
    -
    -
    -
    -
    -
    -

    Creates a PageCoordinatorDataSource with the given pages and looping capabilities.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(pages: [UIViewController], loop: Bool)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - pages - - -
    -

    The pages to be shown in the UIPageViewController.

    -
    -
    - - loop - - -
    -

    Whether or not the pages of the UIPageViewController should be in a loop, -i.e. whether a swipe to the left of the last page should result in the first page being shown -(or the last shown when swiping right on the first page) -If you specify false here, the user cannot swipe left on the last page and right on the first.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Methods

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    See UIPageViewControllerDataSource -for further information.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func presentationCount(for pageViewController: UIPageViewController) -> Int
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - pageViewController - - -
    -

    The dataSource owner.

    -
    -
    -
    -
    -

    Return Value

    -

    The count of pages, if it is displayed. Otherwise 0.

    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UIPageViewControllerDataSource -for further information.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func presentationIndex(for pageViewController: UIPageViewController) -> Int
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - pageViewController - - -
    -

    The dataSource owner.

    -
    -
    -
    -
    -

    Return Value

    -

    The index of the currently visible view controller.

    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UIPageViewControllerDataSource -for further information.

    - -

    This method first searches for the index of the given viewController in the pages array. -It then tries to find a viewController at the preceding position by potentially looping.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func pageViewController(_ pageViewController: UIPageViewController,
-                             viewControllerBefore viewController: UIViewController) -> UIViewController?
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - pageViewController - - -
    -

    The dataSource owner.

    -
    -
    - - viewController - - -
    -

    The viewController to find the preceding viewController of.

    -
    -
    -
    -
    -

    Return Value

    -

    The preceding viewController.

    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UIPageViewControllerDataSource -for further information.

    - -

    This method first searches for the index of the given viewController in the pages array. -It then tries to find a viewController at the following position by potentially looping.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func pageViewController(_ pageViewController: UIPageViewController,
-                             viewControllerAfter viewController: UIViewController) -> UIViewController?
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - pageViewController - - -
    -

    The dataSource owner.

    -
    -
    - - viewController - - -
    -

    The viewController to find the following viewController of.

    -
    -
    -
    -
    -

    Return Value

    -

    The following viewController.

    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/RedirectionRouter.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/RedirectionRouter.html deleted file mode 100644 index 4685534c..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/RedirectionRouter.html +++ /dev/null @@ -1,535 +0,0 @@ - - - - RedirectionRouter Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - RedirectionRouter Class Reference -

- -
- -
- -
-
-

RedirectionRouter

-
-
- 
open class RedirectionRouter<ParentRoute, RouteType> : Router where ParentRoute : Route, RouteType : Route
- -
-
-

RedirectionRouters can be used to extract routes into different route types. -Instead of having one huge route and one or more huge coordinators, you can create separate redirecting routers.

- -

Create a RedirectionRouter from a parent router by providing a reference to that parent. -Triggered routes of the RedirectionRouter will be redirected to this parent router according to the provided mapping. -Please provide either a map closure in the initializer or override the mapToParentRoute method.

- -

A RedirectionRouter has a viewController which is used in transitions, -e.g. when you are presenting, pushing, or otherwise displaying it.

- -
-
- -
-
-
-
- - - -

Stored properties

- -
-
    -
  • -
    - - - - parent - -
    -
    -
    -
    -
    -
    -

    A type-erased Router object of the parent router.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public let parent: UnownedRouter<ParentRoute>
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Computed properties

- -
-
    -
  • -
    - - - - viewController - -
    -
    -
    -
    -
    -
    -

    The viewController used in transitions, e.g. when pushing, presenting -or otherwise displaying the RedirectionRouter.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public private(set) var viewController: UIViewController!
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Initialization

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Creates a RedirectionRouter with a certain viewController, a parent router -and an optional mapping.

    -
    -

    Note

    -

    Make sure to either override mapToSuperRoute or to specify a closure for the map parameter. -If you override mapToSuperRoute, the map parameter is ignored.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(viewController: UIViewController,
-            parent: UnownedRouter<ParentRoute>,
-            map: ((RouteType) -> ParentRoute)?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - viewController - - -
    -

    The view controller to be used in transitions, e.g. when pushing, presenting or otherwise displaying the RedirectionRouter.

    -
    -
    - - parent - - -
    -

    Triggered routes will be rerouted to the parent router.

    -
    -
    - - map - - -
    -

    A mapping from this RedirectionRouter’s routes to the parent’s routes.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Methods

- -
-
    -
  • - -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func contextTrigger(_ route: RouteType,
-                         with options: TransitionOptions,
-                         completion: ContextPresentationHandler?)
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - mapToParentRoute(_:) - -
    -
    -
    -
    -
    -
    -

    Map RouteType to ParentRoute.

    - -

    This method is called when a route is triggered in the RedirectionRouter. -It is used to translate RouteType routes to the parent’s routes which are then triggered in the parent router.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func mapToParentRoute(_ route: RouteType) -> ParentRoute
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - route - - -
    -

    The route to be mapped.

    -
    -
    -
    -
    -

    Return Value

    -

    The mapped route for the parent router.

    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/SplitCoordinator.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/SplitCoordinator.html deleted file mode 100644 index d688c8f3..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/SplitCoordinator.html +++ /dev/null @@ -1,369 +0,0 @@ - - - - SplitCoordinator Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - SplitCoordinator Class Reference -

- -
- -
- -
-
-

SplitCoordinator

-
-
- 
open class SplitCoordinator<RouteType> : BaseCoordinator<RouteType, SplitTransition> where RouteType : Route
- -
-
-

SplitCoordinator can be used as a basis for a coordinator with a rootViewController of type -UISplitViewController.

- -

You can use all SplitTransitions and get an initializer to set a master and -(optional) detail presentable.

- -
-
- -
-
-
-
- - - -

Initialization

- -
-
    -
  • - -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public override init(rootViewController: RootViewController = .init(), initialRoute: RouteType?)
    - -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Creates a SplitCoordinator and sets the specified presentables as the rootViewController’s -viewControllers.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(rootViewController: RootViewController = .init(), master: Presentable, detail: Presentable?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - master - - -
    -

    The presentable to be shown as master in the UISplitViewController.

    -
    -
    - - detail - - -
    -

    The presentable to be shown as detail in the UISplitViewController. This is optional due to -the fact that it might not be useful to have a detail page right away on a small-screen device.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/StaticTransitionAnimation.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/StaticTransitionAnimation.html deleted file mode 100644 index c0a8e4dc..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/StaticTransitionAnimation.html +++ /dev/null @@ -1,526 +0,0 @@ - - - - StaticTransitionAnimation Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - StaticTransitionAnimation Class Reference -

- -
- -
- -
-
-

StaticTransitionAnimation

-
-
- 
open class StaticTransitionAnimation : NSObject, TransitionAnimation
- -
-
-

StaticTransitionAnimation can be used to realize static transition animations.

-
-

Note

- Consider using InteractiveTransitionAnimation instead, if possible, as it is as simple -to use. However, this class is helpful to make sure your transition animation is not mistaken to be -interactive, if your animation code does not fulfill the requirements of an interactive transition -animation. - -
- -
-
- -
-
-
-
- - - -

Computed properties

- -
- -
-
-
- - - -

Initialization

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Creates a StaticTransitionAnimation to be used as presentation or dismissal transition animation in -an Animation object.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(duration: TimeInterval, performAnimation: @escaping (_ context: UIViewControllerContextTransitioning) -> Void)
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Methods

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    See UIViewControllerAnimatedTransitioning -for further information.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func transitionDuration(using transitionContext: UIViewControllerContextTransitioning?) -> TimeInterval
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - transitionContext - - -
    -

    The context of the current transition.

    -
    -
    -
    -
    -

    Return Value

    -

    The duration of the animation as specified in the initializer.

    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UIViewControllerAnimatedTransitioning -for further information.

    - -

    This method performs the animation as specified in the initializer.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func animateTransition(using transitionContext: UIViewControllerContextTransitioning)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - transitionContext - - -
    -

    The context of the current transition.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

TransitionAnimation

- -
-
    -
  • -
    - - - - start() - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func start()
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - cleanup() - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func cleanup()
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/StrongRouter.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/StrongRouter.html deleted file mode 100644 index 51bd8daf..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/StrongRouter.html +++ /dev/null @@ -1,625 +0,0 @@ - - - - StrongRouter Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - StrongRouter Class Reference -

- -
- -
- -
-
-

StrongRouter

-
-
- 
public final class StrongRouter<RouteType> : Router where RouteType : Route
- -
-
-

StrongRouter is a type-erasure of a given Router object and, therefore, can be used as an abstraction from a specific Router -implementation without losing type information about its RouteType.

- -

StrongRouter abstracts away any implementation specific details and -essentially reduces them to properties specified in the Router protocol.

-
-

Note

- Do not hold a reference to any router from the view hierarchy. -Use UnownedRouter or WeakRouter in your view controllers or view models instead. -You can create them using the Coordinator.unownedRouter and Coordinator.weakRouter properties. - -
- -
-
- -
-
-
-
- - - -

Initialization

- -
-
    -
  • -
    - - - - init(_:) - -
    -
    -
    -
    -
    -
    -

    Creates a StrongRouter object from a given router.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init<T>(_ router: T) where RouteType == T.RouteType, T : Router
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - router - - -
    -

    The source router.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Public methods

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Triggers routes and provides the transition context in the completion-handler.

    - -

    Useful for deep linking. It is encouraged to use trigger instead, if the context is not needed.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func contextTrigger(_ route: RouteType,
-                           with options: TransitionOptions,
-                           completion: ContextPresentationHandler?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - route - - -
    -

    The route to be triggered.

    -
    -
    - - options - - -
    -

    Transition options configuring the execution of transitions, e.g. whether it should be animated.

    -
    -
    - - completion - - -
    -

    If present, this completion handler is executed once the transition is completed -(including animations). -If the context is not needed, use trigger instead.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Triggers the specified route by performing a transition.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func trigger(_ route: RouteType, with options: TransitionOptions, completion: PresentationHandler?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - route - - -
    -

    The route to be triggered.

    -
    -
    - - options - - -
    -

    Transition options for performing the transition, e.g. whether it should be animated.

    -
    -
    - - completion - - -
    -

    If present, this completion handler is executed once the transition is completed -(including animations).

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - presented(from:) - -
    -
    -
    -
    -
    -
    -

    This method is called whenever a Presentable is shown to the user. -It further provides information about the presentable responsible for the presenting.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func presented(from presentable: Presentable?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - presentable - - -
    -

    The context in which the presentable is shown. -This could be a window, another viewController, a coordinator, etc. -nil is specified whenever a context cannot be easily determined.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - viewController - -
    -
    -
    -
    -
    -
    -

    The viewController of the Presentable.

    - -

    In the case of a UIViewController, it returns itself. -A coordinator returns its rootViewController.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var viewController: UIViewController! { get }
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - registerParent(_:) - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func registerParent(_ presentable: Presentable & AnyObject)
    - -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func childTransitionCompleted()
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/TabBarAnimationDelegate.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/TabBarAnimationDelegate.html deleted file mode 100644 index dc902646..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/TabBarAnimationDelegate.html +++ /dev/null @@ -1,725 +0,0 @@ - - - - TabBarAnimationDelegate Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - TabBarAnimationDelegate Class Reference -

- -
- -
- -
-
-

TabBarAnimationDelegate

-
-
- 
open class TabBarAnimationDelegate : NSObject
- -
-
-

TabBarAnimationDelegate is used as the delegate of a TabBarCoordinator’s rootViewController -to allow for transitions to specify transition animations.

- -

TabBarAnimationDelegate conforms to the UITabBarControllerDelegate protocol -and is intended for use as the delegate of one tabbar controller only.

-
-

Note

- Do not override the delegate of a TabBarCoordinator’s rootViewController-delegate. -Instead use the delegate property of the TabBarCoordinator itself. - -
- -
-
- -
-
-
-
- - - -

UITabBarControllerDelegate

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    See UITabBarControllerDelegate -for further reference.

    - -
      -

    • Parameters

      - -
        -
      • tabBarController: The delegate owner.
        • -
      • animationController: The animationController to return the interactionController for.
        • -
      • -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func tabBarController(_ tabBarController: UITabBarController,
-                           interactionControllerFor animationController: UIViewControllerAnimatedTransitioning
-    ) -> UIViewControllerInteractiveTransitioning?
    - -
    -
    -
    -

    Return Value

    -

    If the animationController is a TransitionAnimation, it returns its interactionController. -Otherwise it requests an interactionController from the TabBarCoordinator’s delegate.

    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UITabBarControllerDelegate -for further reference.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func tabBarController(_ tabBarController: UITabBarController,
-                           animationControllerForTransitionFrom fromVC: UIViewController,
-                           to toVC: UIViewController) -> UIViewControllerAnimatedTransitioning?
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - tabBarController - - -
    -

    The delegate owner.

    -
    -
    - - fromVC - - -
    -

    The source view controller of the transition.

    -
    -
    - - toVC - - -
    -

    The destination view controller of the transition.

    -
    -
    -
    -
    -

    Return Value

    -

    The presentation animation controller from the toVC’s transitioningDelegate. -If not present, it uses the TabBarCoordinator’s delegate as fallback.

    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UITabBarControllerDelegate -for further reference.

    - -

    This method delegates to the TabBarCoordinator’s delegate.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func tabBarController(_ tabBarController: UITabBarController,
-                           didSelect viewController: UIViewController)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - tabBarController - - -
    -

    The delegate owner.

    -
    -
    - - viewController - - -
    -

    The destination viewController.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UITabBarControllerDelegate -for further reference.

    - -

    This method delegates to the TabBarCoordinator’s delegate.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func tabBarController(_ tabBarController: UITabBarController,
-                           shouldSelect viewController: UIViewController) -> Bool
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - tabBarController - - -
    -

    The delegate owner.

    -
    -
    - - viewController - - -
    -

    The destination viewController.

    -
    -
    -
    -
    -

    Return Value

    -

    The result of the TabBarCooordinator’s delegate. If not specified, it returns true.

    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UITabBarControllerDelegate -for further reference.

    - -

    This method delegates to the TabBarCoordinator’s delegate.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func tabBarController(_ tabBarController: UITabBarController,
-                           willBeginCustomizing viewControllers: [UIViewController])
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - tabBarController - - -
    -

    The delegate owner.

    -
    -
    - - viewControllers - - -
    -

    The source viewControllers.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UITabBarControllerDelegate -for further reference.

    - -

    This method delegates to the TabBarCoordinator’s delegate.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func tabBarController(_ tabBarController: UITabBarController,
-                           didEndCustomizing viewControllers: [UIViewController], changed: Bool)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - tabBarController - - -
    -

    The delegate owner.

    -
    -
    - - viewControllers - - -
    -

    The source viewControllers.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    See UITabBarControllerDelegate -for further reference.

    - -

    This method delegates to the TabBarCoordinator’s delegate.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    open func tabBarController(_ tabBarController: UITabBarController,
-                           willEndCustomizing viewControllers: [UIViewController], changed: Bool)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - tabBarController - - -
    -

    The delegate owner.

    -
    -
    - - viewControllers - - -
    -

    The source viewControllers.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/TabBarCoordinator.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/TabBarCoordinator.html deleted file mode 100644 index 76bec17b..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/TabBarCoordinator.html +++ /dev/null @@ -1,512 +0,0 @@ - - - - TabBarCoordinator Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - TabBarCoordinator Class Reference -

- -
- -
- -
-
-

TabBarCoordinator

-
-
- 
open class TabBarCoordinator<RouteType> : BaseCoordinator<RouteType, TabBarTransition> where RouteType : Route
- -
-
-

Use a TabBarCoordinator to coordinate a flow where a UITabbarController serves as a rootViewController. -With a TabBarCoordinator, you get access to all tabbarController-related transitions.

- -
-
- -
-
-
-
- - - -

Computed properties

- -
-
    -
  • -
    - - - - delegate - -
    -
    -
    -
    -
    -
    -

    Use this delegate to get informed about tabbarController-related notifications and delegate methods -specifying transition animations. The delegate is only referenced weakly.

    - -

    Set this delegate instead of overriding the delegate of the rootViewController -specified in the initializer, if possible, to allow for transition animations -to be executed as specified in the prepareTransition(for:) method.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var delegate: UITabBarControllerDelegate? { get set }
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Initialization

- -
-
    -
  • - -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public override init(rootViewController: RootViewController = .init(), initialRoute: RouteType?)
    - -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Creates a TabBarCoordinator with a specified set of tabs.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(rootViewController: RootViewController = .init(), tabs: [Presentable])
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - tabs - - -
    -

    The presentables to be used as tabs.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Creates a TabBarCoordinator with a specified set of tabs and selects a specific presentable.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(rootViewController: RootViewController = .init(), tabs: [Presentable], select: Presentable)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - tabs - - -
    -

    The presentables to be used as tabs.

    -
    -
    - - select - - -
    -

    The presentable to be selected before displaying. Make sure, this presentable is one of the -specified tabs in the other parameter.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Creates a TabBarCoordinator with a specified set of tabs and selects a presentable at a given index.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(rootViewController: RootViewController = .init(), tabs: [Presentable], select: Int)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - tabs - - -
    -

    The presentables to be used as tabs.

    -
    -
    - - select - - -
    -

    The index of the presentable to be selected before displaying.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/ViewCoordinator.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/ViewCoordinator.html deleted file mode 100644 index d9cd3ad3..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Classes/ViewCoordinator.html +++ /dev/null @@ -1,305 +0,0 @@ - - - - ViewCoordinator Class Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - ViewCoordinator Class Reference -

- -
- -
- -
-
-

ViewCoordinator

-
-
- 
open class ViewCoordinator<RouteType> : BaseCoordinator<RouteType, ViewTransition> where RouteType : Route
- -
-
-

ViewCoordinator is a base class for custom coordinators with a UIViewController rootViewController.

- -
-
- -
-
-
-
- - - -

Initialization

- -
-
    -
  • - -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public override init(rootViewController: RootViewController, initialRoute: RouteType? = nil)
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Extensions.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Extensions.html deleted file mode 100644 index 83651e5a..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Extensions.html +++ /dev/null @@ -1,327 +0,0 @@ - - - - Extensions Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - Extensions Reference -

- -
- -
- -
-
-

Extensions

-

The following extensions are available globally.

- -
-
- -
-
-
-
- - - -

Extensions

- -
- -
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Extensions/UIView.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Extensions/UIView.html deleted file mode 100644 index 7b36d198..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Extensions/UIView.html +++ /dev/null @@ -1,323 +0,0 @@ - - - - UIView Extension Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - UIView Extension Reference -

- -
- -
- -
-
-

UIView

-
-
- 
extension UIView: Container
- -
-
- -
-
- -
-
-
-
    -
  • -
    - - - - viewController - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var viewController: UIViewController! { get }
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - view - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var view: UIView! { get }
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Extensions/UIViewController.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Extensions/UIViewController.html deleted file mode 100644 index 0115ec93..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Extensions/UIViewController.html +++ /dev/null @@ -1,297 +0,0 @@ - - - - UIViewController Extension Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - UIViewController Extension Reference -

- -
- -
- -
-
-

UIViewController

-
-
- 
extension UIViewController: Container
- -
-
- -
-
- -
-
-
-
    -
  • -
    - - - - viewController - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var viewController: UIViewController! { get }
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols.html deleted file mode 100644 index 46c84776..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols.html +++ /dev/null @@ -1,616 +0,0 @@ - - - - Protocols Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - Protocols Reference -

- -
- -
- -
-
-

Protocols

-

The following protocols are available globally.

- -
-
- -
-
-
-
    -
  • -
    - - - - Container - -
    -
    -
    -
    -
    -
    -

    Container abstracts away from the difference of UIView and UIViewController

    - -

    With the Container protocol, UIView and UIViewController objects can be used interchangeably, -e.g. when embedding containers into containers.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public protocol Container
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - Coordinator - -
    -
    -
    -
    -
    -
    -

    Coordinator is the protocol every coordinator conforms to.

    - -

    It requires an object to be able to trigger routes and perform transitions. -This connection is created using the prepareTransition(for:) method.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public protocol Coordinator : Router, TransitionPerformer
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - TransitionContext - -
    -
    -
    -
    -
    -
    -

    TransitionContext provides context information about transitions.

    - -

    It is especially useful for deep linking as XCoordinator can internally gather information about -the presentables being pushed onto the view hierarchy.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public protocol TransitionContext
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - Presentable - -
    -
    -
    -
    -
    -
    -

    Presentable represents all objects that can be presented (i.e. shown) to the user.

    - -

    Therefore, it is useful for view controllers, coordinators and views. -Presentable is often used for transitions to allow for view controllers and coordinators to be transitioned to.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public protocol Presentable
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - Route - -
    -
    -
    -
    -
    -
    -

    This is the protocol your route types need to conform to.

    -
    -

    Note

    - It has no requirements, although the use of enums is encouraged to make your -navigation code type safe. - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public protocol Route
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - Router - -
    -
    -
    -
    -
    -
    -

    The Router protocol is used to abstract the transition-type specific characteristics of a Coordinator.

    - -

    A Router can trigger routes, which lead to transitions being executed. In constrast to the Coordinator protocol, -the router does not specify a TransitionType and can therefore be used in the form of a -StrongRouter, UnownedRouter or WeakRouter to reduce a coordinator’s capabilities to -the triggering of routes. -This may especially be useful in viewModels when using them in different contexts.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public protocol Router : Presentable
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - TransitionAnimation - -
    -
    -
    -
    -
    -
    -

    TransitionAnimation aims to provide a common protocol for any type of transition animation used in an Animation object.

    - -

    XCoordinator provides different implementations of this protocol with the StaticTransitionAnimation, -InteractiveTransitionAnimation and InterruptibleTransitionAnimation classes.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public protocol TransitionAnimation : UIViewControllerAnimatedTransitioning
    - -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    PercentDrivenInteractionController is used for interaction controller types that can updated based on a percentage of completion. -Furthermore, a PercentDrivenInteractionController should be able to cancel and finish a transition animation.

    - -

    PercentDrivenInteractionController is based on the UIViewControllerInteractiveTransitioning protocol.

    -
    -

    Note

    - While you can implement your custom implementation, -UIKit offers a default implementation with UIPercentDrivenInteractiveTransition. - -
    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public protocol PercentDrivenInteractionController : UIViewControllerInteractiveTransitioning
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - TransitionPerformer - -
    -
    -
    -
    -
    -
    -

    The TransitionPerformer protocol is used to abstract the route-type specific characteristics of a Coordinator. -It keeps type information about its transition performing capabilities.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public protocol TransitionPerformer : Presentable
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - TransitionProtocol - -
    -
    -
    -
    -
    -
    -

    TransitionProtocol is used to abstract any concrete transition implementation.

    - -

    Transition is provided as an easily-extensible default transition type implementation.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public protocol TransitionProtocol : TransitionContext
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols/Container.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols/Container.html deleted file mode 100644 index 2a868a42..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols/Container.html +++ /dev/null @@ -1,339 +0,0 @@ - - - - Container Protocol Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - Container Protocol Reference -

- -
- -
- -
-
-

Container

-
-
- 
public protocol Container
- -
-
-

Container abstracts away from the difference of UIView and UIViewController

- -

With the Container protocol, UIView and UIViewController objects can be used interchangeably, -e.g. when embedding containers into containers.

- -
-
- -
-
-
-
    -
  • -
    - - - - view - -
    -
    -
    -
    -
    -
    -

    The view of the Container.

    -
    -

    Note

    - It might not exist for a UIViewController. - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    var view: UIView! { get }
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - viewController - -
    -
    -
    -
    -
    -
    -

    The viewController of the Container.

    -
    -

    Note

    - It might not exist for a UIView. - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    var viewController: UIViewController! { get }
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols/Coordinator.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols/Coordinator.html deleted file mode 100644 index 6fd1b16b..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols/Coordinator.html +++ /dev/null @@ -1,996 +0,0 @@ - - - - Coordinator Protocol Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - Coordinator Protocol Reference -

- -
- -
- -
-
-

Coordinator

-
-
- 
public protocol Coordinator : Router, TransitionPerformer
- -
-
-

Coordinator is the protocol every coordinator conforms to.

- -

It requires an object to be able to trigger routes and perform transitions. -This connection is created using the prepareTransition(for:) method.

- -
-
- -
-
-
-
    -
  • - -
    -
    -
    -
    -
    -

    This method prepares transitions for routes. -It especially decides, which transitions are performed for the triggered routes.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func prepareTransition(for route: RouteType) -> TransitionType
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - route - - -
    -

    The triggered route for which a transition is to be prepared.

    -
    -
    -
    -
    -

    Return Value

    -

    The prepared transition.

    -
    -
    -
    -
    • -
  • -
    - - - - addChild(_:) - -
    -
    -
    -
    -
    -
    -

    This method adds a child to a coordinator’s children.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func addChild(_ presentable: Presentable)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - presentable - - -
    -

    The child to be added.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - removeChild(_:) - -
    -
    -
    -
    -
    -
    -

    This method removes a child to a coordinator’s children.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func removeChild(_ presentable: Presentable)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - presentable - - -
    -

    The child to be removed.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    This method removes all children that are no longer in the view hierarchy.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func removeChildrenIfNeeded()
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Typealiases

- -
-
    -
  • -
    - - - - RootViewController - - - Extension method - -
    -
    -
    -
    -
    -
    -

    Shortcut for Coordinator.TransitionType.RootViewController

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public typealias RootViewController = TransitionType.RootViewController
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Presentable

- -
-
    -
  • -
    - - - - viewController - - - Extension method - -
    -
    -
    -
    -
    -
    -

    A Coordinator uses its rootViewController as viewController.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var viewController: UIViewController! { get }
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Presentable

- -
-
    -
  • -
    - - - - weakRouter - - - Extension method - -
    -
    -
    -
    -
    -
    -

    Creates a WeakRouter object from the given router to abstract from concrete implementations -while maintaining information necessary to fulfill the Router protocol. -The original router will be held weakly.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var weakRouter: WeakRouter<RouteType> { get }
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - unownedRouter - - - Extension method - -
    -
    -
    -
    -
    -
    -

    Creates an UnownedRouter object from the given router to abstract from concrete implementations -while maintaining information necessary to fulfill the Router protocol. -The original router will be held unowned.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var unownedRouter: UnownedRouter<RouteType> { get }
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Default implementations

- -
-
    -
  • -
    - - - - anyCoordinator - - - Extension method - -
    -
    -
    -
    -
    -
    -

    Creates an AnyCoordinator based on the current coordinator.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var anyCoordinator: AnyCoordinator<RouteType, TransitionType> { get }
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - presented(from:) - - - Extension method - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func presented(from presentable: Presentable?)
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - childTransitionCompleted() - - - Extension method - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func childTransitionCompleted()
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - contextTrigger(_:with:completion:) - - - Extension method - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func contextTrigger(_ route: RouteType,
-                           with options: TransitionOptions,
-                           completion: ContextPresentationHandler?)
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - chain(routes:) - - - Extension method - -
    -
    -
    -
    -
    -
    -

    With chain(routes:) different routes can be chained together to form a combined transition.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func chain(routes: [RouteType]) -> TransitionType
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - routes - - -
    -

    The routes to be chained.

    -
    -
    -
    -
    -

    Return Value

    -

    A transition combining the transitions of the specified routes.

    -
    -
    -
    -
    • -
  • -
    - - - - performTransition(_:with:completion:) - - - Extension method - -
    -
    -
    -
    -
    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func performTransition(_ transition: TransitionType,
-                              with options: TransitionOptions,
-                              completion: PresentationHandler? = nil)
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Coordinator + DeepLinking

- -
-
    -
  • -
    - - - - deepLink(_:_:) - - - Extension method - -
    -
    -
    -
    -
    -
    -

    Deep-Linking can be used to chain routes of different types together.

    -
    -

    Note

    -

    Use it with caution, as it is not implemented in a type-safe manner. -Keep in mind that changes in the app’s structure and changes of transitions -behind the given routes can lead to runtime errors and, therefore, crashes of your app.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func deepLink<RootViewController, S: Sequence>(_ route: RouteType, _ remainingRoutes: S)
-    -> Transition<RootViewController> where S.Element == Route, TransitionType == Transition<RootViewController>
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - route - - -
    -

    The first route in the chain. -It is given a special place because its exact type can be specified.

    -
    -
    - - remainingRoutes - - -
    -

    The remaining routes of the chain.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - deepLink(_:_:) - - - Extension method - -
    -
    -
    -
    -
    -
    -

    Deep-Linking can be used to chain routes of different types together.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func deepLink<RootViewController>(_ route: RouteType, _ remainingRoutes: Route...)
-    -> Transition<RootViewController> where TransitionType == Transition<RootViewController>
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - registerPeek(for:route:) - - - Extension method - -
    -
    -
    -
    -
    -
    -

    Use this transition to register 3D Touch Peek and Pop functionality.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    @available(iOS, introduced: 9.0, deprecated: 13.0, message: "Use `UIContextMenuInteraction` instead.")
-public func registerPeek<RootViewController>(for source: Container,
-                                             route: RouteType
-    ) -> Transition<RootViewController> where Self.TransitionType == Transition<RootViewController>
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - source - - -
    -

    The view to register peek and pop on.

    -
    -
    - - route - - -
    -

    The route to be triggered for peek and pop.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols/PercentDrivenInteractionController.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols/PercentDrivenInteractionController.html deleted file mode 100644 index c0d3e12d..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols/PercentDrivenInteractionController.html +++ /dev/null @@ -1,365 +0,0 @@ - - - - PercentDrivenInteractionController Protocol Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - PercentDrivenInteractionController Protocol Reference -

- -
- -
- -
-
-

PercentDrivenInteractionController

-
-
- 
public protocol PercentDrivenInteractionController : UIViewControllerInteractiveTransitioning
- -
-
-

PercentDrivenInteractionController is used for interaction controller types that can updated based on a percentage of completion. -Furthermore, a PercentDrivenInteractionController should be able to cancel and finish a transition animation.

- -

PercentDrivenInteractionController is based on the UIViewControllerInteractiveTransitioning protocol.

-
-

Note

- While you can implement your custom implementation, -UIKit offers a default implementation with UIPercentDrivenInteractiveTransition. - -
- -
-
- -
-
-
-
    -
  • -
    - - - - update(_:) - -
    -
    -
    -
    -
    -
    -

    Updates the animation to be at the specified progress.

    - -

    This method is called based on user interactions. -A linear progression of the animation is encouraged when handling user interactions.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func update(_ percentComplete: CGFloat)
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - cancel() - -
    -
    -
    -
    -
    -
    -

    Cancels the animation, e.g. by cleaning up and reversing any progress made.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func cancel()
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - finish() - -
    -
    -
    -
    -
    -
    -

    Finishes the animation by completing it from the current progress onwards.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func finish()
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols/Presentable.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols/Presentable.html deleted file mode 100644 index def33f99..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols/Presentable.html +++ /dev/null @@ -1,551 +0,0 @@ - - - - Presentable Protocol Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - Presentable Protocol Reference -

- -
- -
- -
-
-

Presentable

-
-
- 
public protocol Presentable
- -
-
-

Presentable represents all objects that can be presented (i.e. shown) to the user.

- -

Therefore, it is useful for view controllers, coordinators and views. -Presentable is often used for transitions to allow for view controllers and coordinators to be transitioned to.

- -
-
- -
-
-
-
    -
  • -
    - - - - viewController - -
    -
    -
    -
    -
    -
    -

    The viewController of the Presentable.

    - -

    In the case of a UIViewController, it returns itself. -A coordinator returns its rootViewController.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    var viewController: UIViewController! { get }
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - router(for:) - - - Default implementation - -
    -
    -
    -
    -
    -
    -

    This method can be used to retrieve whether the presentable can trigger a specific route -and potentially returns a router to trigger the route on.

    - -

    Deep linking makes use of this method to trigger the specified routes.

    - -
    -

    Default Implementation

    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func router<R>(for route: R) -> StrongRouter<R>? where R : Route
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - route - - -
    -

    The route to determine a router for.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - presented(from:) - - - Default implementation - -
    -
    -
    -
    -
    -
    -

    This method is called whenever a Presentable is shown to the user. -It further provides information about the context a presentable is shown in.

    - -
    -

    Default Implementation

    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func presented(from presentable: Presentable?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - presentable - - -
    -

    The context in which the presentable is shown. -This could be a window, another viewController, a coordinator, etc. -nil is specified whenever a context cannot be easily determined.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - registerParent(_:) - - - Default implementation - -
    -
    -
    -
    -
    -
    -

    This method is used to register a parent coordinator to a child coordinator.

    -
    -

    Note

    - This method is used internally and should never be called directly. - -
    - -
    -

    Default Implementation

    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func registerParent(_ presentable: Presentable & AnyObject)
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - childTransitionCompleted() - - - Default implementation - -
    -
    -
    -
    -
    -
    -

    This method gets called when the transition of a child coordinator is being reported to its parent.

    -
    -

    Note

    - This method is used internally and should never be called directly. - -
    - -
    -

    Default Implementation

    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func childTransitionCompleted()
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - setRoot(for:) - - - Default implementation - -
    -
    -
    -
    -
    -
    -

    Sets the presentable as the root of the window.

    - -

    This method sets the rootViewController of the window and makes it key and visible. -Furthermore, it calls presented(from:) with the window as its parameter.

    - -
    -

    Default Implementation

    -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func setRoot(for window: UIWindow)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - window - - -
    -

    The window to set the root of.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols/Router.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols/Router.html deleted file mode 100644 index 29ffd2c0..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols/Router.html +++ /dev/null @@ -1,685 +0,0 @@ - - - - Router Protocol Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - Router Protocol Reference -

- -
- -
- -
-
-

Router

-
-
- 
public protocol Router : Presentable
- -
-
-

The Router protocol is used to abstract the transition-type specific characteristics of a Coordinator.

- -

A Router can trigger routes, which lead to transitions being executed. In constrast to the Coordinator protocol, -the router does not specify a TransitionType and can therefore be used in the form of a -StrongRouter, UnownedRouter or WeakRouter to reduce a coordinator’s capabilities to -the triggering of routes. -This may especially be useful in viewModels when using them in different contexts.

- -
-
- -
-
-
-
    -
  • -
    - - - - RouteType - -
    -
    -
    -
    -
    -
    -

    RouteType defines which routes can be triggered in a certain Router implementation.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    associatedtype RouteType : Route
    - -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Triggers routes and returns context in completion-handler.

    - -

    Useful for deep linking. It is encouraged to use trigger instead, if the context is not needed.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func contextTrigger(_ route: RouteType, with options: TransitionOptions, completion: ContextPresentationHandler?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - route - - -
    -

    The route to be triggered.

    -
    -
    - - options - - -
    -

    Transition options configuring the execution of transitions, e.g. whether it should be animated.

    -
    -
    - - completion - - -
    -

    If present, this completion handler is executed once the transition is completed -(including animations). -If the context is not needed, use trigger instead.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Convenience methods

- -
-
    -
  • -
    - - - - trigger(_:with:) - - - Extension method - -
    -
    -
    -
    -
    -
    -

    Triggers the specified route without the need of specifying a completion handler.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func trigger(_ route: RouteType, with options: TransitionOptions)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - route - - -
    -

    The route to be triggered.

    -
    -
    - - options - - -
    -

    Transition options for performing the transition, e.g. whether it should be animated.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - trigger(_:completion:) - - - Extension method - -
    -
    -
    -
    -
    -
    -

    Triggers the specified route with default transition options enabling the animation of the transition.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func trigger(_ route: RouteType, completion: PresentationHandler? = nil)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - route - - -
    -

    The route to be triggered.

    -
    -
    - - completion - - -
    -

    If present, this completion handler is executed once the transition is completed -(including animations).

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - trigger(_:with:completion:) - - - Extension method - -
    -
    -
    -
    -
    -
    -

    Triggers the specified route by performing a transition.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func trigger(_ route: RouteType, with options: TransitionOptions, completion: PresentationHandler?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - route - - -
    -

    The route to be triggered.

    -
    -
    - - options - - -
    -

    Transition options for performing the transition, e.g. whether it should be animated.

    -
    -
    - - completion - - -
    -

    If present, this completion handler is executed once the transition is completed -(including animations).

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Computed properties

- -
-
    -
  • -
    - - - - strongRouter - - - Extension method - -
    -
    -
    -
    -
    -
    -

    Creates a StrongRouter object from the given router to abstract from concrete implementations -while maintaining information necessary to fulfill the Router protocol. -The original router will be held strongly.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var strongRouter: StrongRouter<RouteType> { get }
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - router(for:) - - - Extension method - -
    -
    -
    -
    -
    -
    -

    Returns a router for the specified route, if possible.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func router<R>(for route: R) -> StrongRouter<R>? where R : Route
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - route - - -
    -

    The route type to return a router for.

    -
    -
    -
    -
    -

    Return Value

    -

    It returns the router’s strongRouter, -if it is compatible with the given route type, -otherwise nil.

    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols/TransitionAnimation.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols/TransitionAnimation.html deleted file mode 100644 index da9eb644..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols/TransitionAnimation.html +++ /dev/null @@ -1,362 +0,0 @@ - - - - TransitionAnimation Protocol Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - TransitionAnimation Protocol Reference -

- -
- -
- -
-
-

TransitionAnimation

-
-
- 
public protocol TransitionAnimation : UIViewControllerAnimatedTransitioning
- -
-
-

TransitionAnimation aims to provide a common protocol for any type of transition animation used in an Animation object.

- -

XCoordinator provides different implementations of this protocol with the StaticTransitionAnimation, -InteractiveTransitionAnimation and InterruptibleTransitionAnimation classes.

- -
-
- -
-
-
-
    -
  • -
    - - - - interactionController - -
    -
    -
    -
    -
    -
    -

    The interaction controller of an animation. -It gets notified about the state of an animation and handles the specific events accordingly.

    - -

    The interaction controller is reset when calling TransitionAnimation.start() can always be nil, -e.g. in static transition animations.

    - -

    Until TransitionAnimation.cleanup() is called, it should always return the same instance.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    var interactionController: PercentDrivenInteractionController? { get }
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - start() - -
    -
    -
    -
    -
    -
    -

    Starts the animation by possibly creating a new interaction controller.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func start()
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - cleanup() - -
    -
    -
    -
    -
    -
    -

    Cleans up a TransitionAnimation after an animation has been completed, e.g. by deleting an interaction controller.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func cleanup()
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols/TransitionContext.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols/TransitionContext.html deleted file mode 100644 index f519a608..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols/TransitionContext.html +++ /dev/null @@ -1,335 +0,0 @@ - - - - TransitionContext Protocol Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - TransitionContext Protocol Reference -

- -
- -
- -
-
-

TransitionContext

-
-
- 
public protocol TransitionContext
- -
-
-

TransitionContext provides context information about transitions.

- -

It is especially useful for deep linking as XCoordinator can internally gather information about -the presentables being pushed onto the view hierarchy.

- -
-
- -
-
-
-
    -
  • -
    - - - - presentables - -
    -
    -
    -
    -
    -
    -

    The presentables being shown to the user by the transition.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    var presentables: [Presentable] { get }
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - animation - -
    -
    -
    -
    -
    -
    -

    The transition animation directly used in the transition, if applicable.

    -
    -

    Note

    - Make sure to not return nil, if you want to use BaseCoordinator.registerInteractiveTransition -to realize an interactive transition. - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    var animation: TransitionAnimation? { get }
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols/TransitionPerformer.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols/TransitionPerformer.html deleted file mode 100644 index 0df5becf..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols/TransitionPerformer.html +++ /dev/null @@ -1,403 +0,0 @@ - - - - TransitionPerformer Protocol Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - TransitionPerformer Protocol Reference -

- -
- -
- -
-
-

TransitionPerformer

-
-
- 
public protocol TransitionPerformer : Presentable
- -
-
-

The TransitionPerformer protocol is used to abstract the route-type specific characteristics of a Coordinator. -It keeps type information about its transition performing capabilities.

- -
-
- -
-
-
-
    -
  • -
    - - - - TransitionType - -
    -
    -
    -
    -
    -
    -

    The type of transitions that can be executed on the rootViewController.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    associatedtype TransitionType : TransitionProtocol
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - rootViewController - -
    -
    -
    -
    -
    -
    -

    The rootViewController on which transitions are performed.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    var rootViewController: TransitionType.RootViewController { get }
    - -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Perform a transition.

    -
    -

    Warning

    -

    Do not use this method directly, but instead try to use the trigger -method of your coordinator instead wherever possible.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func performTransition(_ transition: TransitionType, with options: TransitionOptions, completion: PresentationHandler?)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - transition - - -
    -

    The transition to be performed.

    -
    -
    - - options - - -
    -

    The options on how to perform the transition, including the option to enable/disable animations.

    -
    -
    - - completion - - -
    -

    The completion handler called once a transition has finished.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols/TransitionProtocol.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols/TransitionProtocol.html deleted file mode 100644 index 30e2c3eb..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Protocols/TransitionProtocol.html +++ /dev/null @@ -1,399 +0,0 @@ - - - - TransitionProtocol Protocol Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - TransitionProtocol Protocol Reference -

- -
- -
- -
-
-

TransitionProtocol

-
-
- 
public protocol TransitionProtocol : TransitionContext
- -
-
-

TransitionProtocol is used to abstract any concrete transition implementation.

- -

Transition is provided as an easily-extensible default transition type implementation.

- -
-
- -
-
-
-
    -
  • -
    - - - - RootViewController - -
    -
    -
    -
    -
    -
    -

    The type of the rootViewController that can execute the transition.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    associatedtype RootViewController : UIViewController
    - -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Performs a transition on the given viewController.

    -
    -

    Warning

    - Do not call this method directly. Instead use your coordinator’s performTransition method or trigger -a specified route (latter option is encouraged). - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    func perform(on rootViewController: RootViewController, with options: TransitionOptions, completion: PresentationHandler?)
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Always accessible transitions

- -
-
    -
  • -
    - - - - multiple(_:) - - - Default implementation - -
    -
    -
    -
    -
    -
    -

    Creates a compound transition by chaining multiple transitions together.

    - -
    -

    Default Implementation

    -
    -

    Creates a compound transition by chaining multiple transitions together.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    static func multiple(_ transitions: [Self]) -> Self
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - transitions - - -
    -

    The transitions to be chained to form a combined transition.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Structs.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Structs.html deleted file mode 100644 index d6d9eafd..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Structs.html +++ /dev/null @@ -1,469 +0,0 @@ - - - - Structures Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - Structures Reference -

- -
- -
- -
-
-

Structures

-

The following structures are available globally.

- -
-
- -
-
-
-
    -
  • -
    - - - - Transition - -
    -
    -
    -
    -
    -
    -

    This struct represents the common implementation of the TransitionProtocol. -It is used in every of the provided BaseCoordinator subclasses and provides all transitions implemented in XCoordinator.

    - -

    Transitions are defined by a Transition.Perform closure. -It further provides different context information such as Transition.presentable and Transition.animation. -You can create your own custom transitions using Transition.init(presentable:animation:perform:) or -use one of the many provided static functions to create the most common transitions.

    -
    -

    Note

    - Transitions have a generic constraint to the rootViewController in use. -Therefore, not all transitions are available in every coordinator. -Make sure to specify the RootViewController type of the TransitionType of your coordinator as precise as possible -to get all already available transitions. - -
    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public struct Transition<RootViewController> : TransitionProtocol where RootViewController : UIViewController
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - TransitionOptions - -
    -
    -
    -
    -
    -
    -

    TransitionOptions specifies transition customization points defined at the point of triggering a transition.

    - -

    You can use TransitionOptions to define whether or not a transition should be animated.

    -
    -

    Note

    - It might be extended in the future to enable more advanced customization options. - -
    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public struct TransitionOptions
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - UnownedErased - -
    -
    -
    -
    -
    -
    -

    UnownedErased is a property wrapper to hold objects with an unowned reference when using type-erasure.

    - -

    Create this wrapper using an initial value and a closure to create the type-erased object. -Make sure to not create an UnownedErased wrapper for already type-erased objects, -since their reference is most likely instantly lost.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    @propertyWrapper
-public struct UnownedErased<Value>
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - UnownedErased - -
    -
    -
    -
    -
    -
    -

    UnownedErased is a property wrapper to hold objects with an unowned reference when using type-erasure.

    - -

    Create this wrapper using an initial value and a closure to create the type-erased object. -Make sure to not create an UnownedErased wrapper for already type-erased objects, -since their reference is most likely instantly lost.

    - - See more -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - WeakErased - -
    -
    -
    -
    -
    -
    -

    WeakErased is a property wrapper to hold objects with a weak reference when using type-erasure.

    - -

    Create this wrapper using an initial value and a closure to create the type-erased object. -Make sure to not create a WeakErased wrapper for already type-erased objects, -since their reference is most likely instantly lost.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    @propertyWrapper
-public struct WeakErased<Value>
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - WeakErased - -
    -
    -
    -
    -
    -
    -

    WeakErased is a property wrapper to hold objects with a weak reference when using type-erasure.

    - -

    Create this wrapper using an initial value and a closure to create the type-erased object. -Make sure to not create a WeakErased wrapper for already type-erased objects, -since their reference is most likely instantly lost.

    - - See more -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Structs/Transition.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Structs/Transition.html deleted file mode 100644 index a054d6f9..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Structs/Transition.html +++ /dev/null @@ -1,1772 +0,0 @@ - - - - Transition Structure Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - Transition Structure Reference -

- -
- -
- -
-
-

Transition

-
-
- 
public struct Transition<RootViewController> : TransitionProtocol where RootViewController : UIViewController
- -
-
-

This struct represents the common implementation of the TransitionProtocol. -It is used in every of the provided BaseCoordinator subclasses and provides all transitions implemented in XCoordinator.

- -

Transitions are defined by a Transition.Perform closure. -It further provides different context information such as Transition.presentable and Transition.animation. -You can create your own custom transitions using Transition.init(presentable:animation:perform:) or -use one of the many provided static functions to create the most common transitions.

-
-

Note

- Transitions have a generic constraint to the rootViewController in use. -Therefore, not all transitions are available in every coordinator. -Make sure to specify the RootViewController type of the TransitionType of your coordinator as precise as possible -to get all already available transitions. - -
- -
-
- -
-
-
-
- - - -

Typealias

- -
-
    -
  • -
    - - - - PerformClosure - -
    -
    -
    -
    -
    -
    -

    Perform is the type of closure used to perform the transition.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public typealias PerformClosure = (_ rootViewController: RootViewController, _ options: TransitionOptions, _ completion: PresentationHandler?) -> Void
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - rootViewController - - -
    -

    The rootViewController to perform the transition on.

    -
    -
    - - options - - -
    -

    The options on how to perform the transition, e.g. whether it should be animated or not.

    -
    -
    - - completion - - -
    -

    The completion handler of the transition. -It is called when the transition (including all animations) is completed.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Computed properties

- -
-
    -
  • -
    - - - - presentables - -
    -
    -
    -
    -
    -
    -

    The presentables this transition is putting into the view hierarchy. This is especially useful for -deep-linking.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var presentables: [Presentable] { get }
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - animation - -
    -
    -
    -
    -
    -
    -

    The transition animation this transition is using, i.e. the presentation or dismissal animation -of the specified Animation object. If the transition does not use any transition animations, nil -is returned.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public var animation: TransitionAnimation? { get }
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Initialization

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Create your custom transitions with this initializer.

    - -

    Extending Transition with static functions to create transitions with this initializer -(instead of calling this initializer in your prepareTransition(for:) method) is advised -as it makes reuse easier.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(presentables: [Presentable], animationInUse: TransitionAnimation?, perform: @escaping PerformClosure)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - presentables - - -
    -

    The presentables this transition is putting into the view hierarchy, if specifiable. -These presentables are used in the deep-linking feature.

    -
    -
    - - animationInUse - - -
    -

    The transition animation this transition is using during the transition, i.e. the present animation -of a presenting transition or the dismissal animation of a dismissing transition. -Make sure to specify an animation here to use your transition with the -registerInteractiveTransition method in your coordinator.

    -
    -
    - - perform - - -
    -

    The perform closure executes the transition. -To create custom transitions, make sure to call the completion handler after all animations are done. -If applicable, make sure to use the TransitionOptions to, e.g., decide whether a transition should be animated or not.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Methods

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Performs a transition on the given viewController.

    -
    -

    Warning

    - Do not call this method directly. Instead use your coordinator’s performTransition method or trigger -a specified route (latter option is encouraged). - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func perform(on rootViewController: RootViewController, with options: TransitionOptions, completion: PresentationHandler?)
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - push(_:animation:) - -
    -
    -
    -
    -
    -
    -

    Pushes a presentable on the rootViewController’s navigation stack.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func push(_ presentable: Presentable, animation: Animation? = nil) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - presentable - - -
    -

    The presentable to be pushed onto the navigation stack.

    -
    -
    - - animation - - -
    -

    The animation to set for the presentable. Its presentationAnimation will be used for the -immediate push-transition, its dismissalAnimation is used for the pop-transition, -if not otherwise specified. Specify nil here to leave animations as they were set for the -presentable before. You can use Animation.default to reset the previously set animations -on this presentable.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - pop(animation:) - -
    -
    -
    -
    -
    -
    -

    Pops the topViewController from the rootViewController’s navigation stack.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func pop(animation: Animation? = nil) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - animation - - -
    -

    The animation to set for the presentable. Only its dismissalAnimation is used for the -pop-transition. Specify nil here to leave animations as they were set for the -presentable before. You can use Animation.default to reset the previously set animations -on this presentable.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - pop(to:animation:) - -
    -
    -
    -
    -
    -
    -

    Pops viewControllers from the rootViewController’s navigation stack until the specified -presentable is reached.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func pop(to presentable: Presentable, animation: Animation? = nil) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - presentable - - -
    -

    The presentable to pop to. Make sure this presentable is in the rootViewController’s -navigation stack before performing such a transition.

    -
    -
    - - animation - - -
    -

    The animation to set for the presentable. Only its dismissalAnimation is used for the -pop-transition. Specify nil here to leave animations as they were set for the -presentable before. You can use Animation.default to reset the previously set animations -on this presentable.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - popToRoot(animation:) - -
    -
    -
    -
    -
    -
    -

    Pops viewControllers from the rootViewController’s navigation stack until only one viewController -is left.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func popToRoot(animation: Animation? = nil) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - animation - - -
    -

    The animation to set for the presentable. Only its dismissalAnimation is used for the -pop-transition. Specify nil here to leave animations as they were set for the -presentable before. You can use Animation.default to reset the previously set animations -on this presentable.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - set(_:animation:) - -
    -
    -
    -
    -
    -
    -

    Replaces the navigation stack of the rootViewController with the specified presentables.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func set(_ presentables: [Presentable], animation: Animation? = nil) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - presentables - - -
    -

    The presentables to make up the navigation stack after the transition is done.

    -
    -
    - - animation - - -
    -

    The animation to set for the presentable. Its presentationAnimation will be used for the -transition animation of the top-most viewController, its dismissalAnimation is used for -any pop-transition of the whole navigation stack, if not otherwise specified. Specify nil -here to leave animations as they were set for the presentables before. You can use -Animation.default to reset the previously set animations on all presentables.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - set(_:_:direction:) - -
    -
    -
    -
    -
    -
    -

    Sets the current page(s) of the rootViewController. Make sure to set -UIPageViewController.isDoubleSided to the appropriate setting before executing this transition.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func set(_ first: Presentable, _ second: Presentable? = nil,
-                       direction: UIPageViewController.NavigationDirection) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - first - - -
    -

    The first page being shown. If second is specified as nil, this reflects a single page -being shown.

    -
    -
    - - second - - -
    -

    The second page being shown. This page is optional, as your rootViewController can be used -with isDoubleSided enabled or not.

    -
    -
    - - direction - - -
    -

    The direction in which the transition should be animated.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - set(_:animation:) - -
    -
    -
    -
    -
    -
    -

    Transition to set the tabs of the rootViewController with an optional custom animation.

    -
    -

    Note

    -

    Only the presentation animation of the Animation object is used.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func set(_ presentables: [Presentable], animation: Animation? = nil) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - presentables - - -
    -

    The tabs to be set are defined by the presentables’ viewControllers.

    -
    -
    - - animation - - -
    -

    The animation to be used. If you specify nil here, the default animation by UIKit is used.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - select(_:animation:) - -
    -
    -
    -
    -
    -
    -

    Transition to select a tab with an optional custom animation.

    -
    -

    Note

    -

    Only the presentation animation of the Animation object is used.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func select(_ presentable: Presentable, animation: Animation? = nil) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - presentable - - -
    -

    The tab to be selected is the presentable’s viewController. Make sure that this is one of the -previously specified tabs of the rootViewController.

    -
    -
    - - animation - - -
    -

    The animation to be used. If you specify nil here, the default animation by UIKit is used.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Transition to select a tab with an optional custom animation.

    -
    -

    Note

    -

    Only the presentation animation of the Animation object is used.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func select(index: Int, animation: Animation? = nil) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - index - - -
    -

    The index of the tab to be selected. Make sure that there is a tab at the specified index.

    -
    -
    - - animation - - -
    -

    The animation to be used. If you specify nil here, the default animation by UIKit is used.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - show(_:) - -
    -
    -
    -
    -
    -
    -

    Shows a viewController by calling show on the rootViewController.

    -
    -

    Note

    -

    Prefer Transition.push when using transitions on a UINavigationController rootViewController. -In contrast to this transition, you can specify an animation.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func show(_ presentable: Presentable) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - presentable - - -
    -

    The presentable to be shown as a primary view controller.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - showDetail(_:) - -
    -
    -
    -
    -
    -
    -

    Shows a detail viewController by calling showDetail on the rootViewController.

    -
    -

    Note

    -

    Prefer Transition.push when using transitions on a UINavigationController rootViewController. -In contrast to this transition, you can specify an animation.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func showDetail(_ presentable: Presentable) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - presentable - - -
    -

    The presentable to be shown as a detail view controller.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Transition to present the given presentable on the rootViewController.

    - -

    The present-transition might also be helpful as it always presents on top of what is currently -presented.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func presentOnRoot(_ presentable: Presentable, animation: Animation? = nil) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - presentable - - -
    -

    The presentable to be presented.

    -
    -
    - - animation - - -
    -

    The animation to be set as the presentable’s transitioningDelegate. Specify nil to not override -the current transitioningDelegate and Animation.default to reset the transitioningDelegate to use -the default UIKit animations.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - present(_:animation:) - -
    -
    -
    -
    -
    -
    -

    Transition to present the given presentable. It uses the rootViewController’s presentedViewController, -if present, otherwise it is equivalent to presentOnRoot.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func present(_ presentable: Presentable, animation: Animation? = nil) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - presentable - - -
    -

    The presentable to be presented.

    -
    -
    - - animation - - -
    -

    The animation to be set as the presentable’s transitioningDelegate. Specify nil to not override -the current transitioningDelegate and Animation.default to reset the transitioningDelegate to use -the default UIKit animations.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - embed(_:in:) - -
    -
    -
    -
    -
    -
    -

    Transition to embed the given presentable in a specific container (i.e. a view or viewController).

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func embed(_ presentable: Presentable, in container: Container) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - presentable - - -
    -

    The presentable to be embedded.

    -
    -
    - - container - - -
    -

    The container to embed the presentable in.

    -
    -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Transition to call dismiss on the rootViewController. Also take a look at the dismiss transition, -which calls dismiss on the rootViewController’s presentedViewController, if present.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func dismissToRoot(animation: Animation? = nil) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - animation - - -
    -

    The animation to be used by the rootViewController’s presentedViewController. -Specify nil to not override its transitioningDelegate or Animation.default to fall back to the -default UIKit animations.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - dismiss(animation:) - -
    -
    -
    -
    -
    -
    -

    Transition to call dismiss on the rootViewController’s presentedViewController, if present. -Otherwise, it is equivalent to dismissToRoot.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func dismiss(animation: Animation? = nil) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - animation - - -
    -

    The animation to be used by the rootViewController’s presentedViewController. -Specify nil to not override its transitioningDelegate or Animation.default to fall back to the -default UIKit animations.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - none() - -
    -
    -
    -
    -
    -
    -

    No transition at all. May be useful for testing or debugging purposes, or to ignore specific -routes.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func none() -> Transition
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - multiple(_:) - -
    -
    -
    -
    -
    -
    -

    With this transition you can chain multiple transitions of the same type together.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func multiple<C>(_ transitions: C) -> Transition where C : Collection, C.Element == Transition<RootViewController>
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - transitions - - -
    -

    The transitions to be chained to form the new transition.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - route(_:on:) - -
    -
    -
    -
    -
    -
    -

    Use this transition to trigger a route on another coordinator. TransitionOptions and -PresentationHandler used during the execution of this transitions are forwarded.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func route<C>(_ route: C.RouteType, on coordinator: C) -> Transition where C : Coordinator
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - route - - -
    -

    The route to be triggered on the coordinator.

    -
    -
    - - coordinator - - -
    -

    The coordinator to trigger the route on.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - trigger(_:on:) - -
    -
    -
    -
    -
    -
    -

    Use this transition to trigger a route on another router. TransitionOptions and -PresentationHandler used during the execution of this transitions are forwarded.

    - -

    Peeking is not supported with this transition. If needed, use the route transition instead.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func trigger<R>(_ route: R.RouteType, on router: R) -> Transition where R : Router
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - route - - -
    -

    The route to be triggered on the coordinator.

    -
    -
    - - router - - -
    -

    The router to trigger the route on.

    -
    -
    -
    -
    -
    -
    • -
  • -
    - - - - perform(_:on:) - -
    -
    -
    -
    -
    -
    -

    Performs a transition on a different viewController than the coordinator’s rootViewController.

    - -

    This might be helpful when creating a coordinator for a specific viewController would create unnecessary complicated code.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public static func perform<TransitionType: TransitionProtocol>(_ transition: TransitionType,
-                                                               on viewController: TransitionType.RootViewController) -> Transition
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - transition - - -
    -

    The transition to be performed.

    -
    -
    - - viewController - - -
    -

    The viewController to perform the transition on.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Structs/TransitionOptions.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Structs/TransitionOptions.html deleted file mode 100644 index 7a1d7027..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Structs/TransitionOptions.html +++ /dev/null @@ -1,376 +0,0 @@ - - - - TransitionOptions Structure Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - TransitionOptions Structure Reference -

- -
- -
- -
-
-

TransitionOptions

-
-
- 
public struct TransitionOptions
- -
-
-

TransitionOptions specifies transition customization points defined at the point of triggering a transition.

- -

You can use TransitionOptions to define whether or not a transition should be animated.

-
-

Note

- It might be extended in the future to enable more advanced customization options. - -
- -
-
- -
-
-
-
- - - -

Stored properties

- -
-
    -
  • -
    - - - - animated - -
    -
    -
    -
    -
    -
    -

    Specifies whether or not the transition should be animated.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public let animated: Bool
    - -
    -
    -
    -
    -
    • -
-
-
-
- - - -

Initialization

- -
-
    -
  • -
    - - - - init(animated:) - -
    -
    -
    -
    -
    -
    -

    Creates transition options on the basis of whether or not it should be animated.

    -
    -

    Note

    -

    Specifying true to enable animations does not necessarily lead to an animated transition, -if the transition does not support it.

    - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public init(animated: Bool)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - animated - - -
    -

    Whether or not the animation should be animated.

    -
    -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Structs/UnownedErased.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Structs/UnownedErased.html deleted file mode 100644 index 4386c53b..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Structs/UnownedErased.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - UnownedErased Structure Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - UnownedErased Structure Reference -

- -
- -
- -
-
-

UnownedErased

-

UnownedErased is a property wrapper to hold objects with an unowned reference when using type-erasure.

- -

Create this wrapper using an initial value and a closure to create the type-erased object. -Make sure to not create an UnownedErased wrapper for already type-erased objects, -since their reference is most likely instantly lost.

- -
-
- -
-
-
-
    -
  • -
    - - - - wrappedValue - -
    -
    -
    -
    -
    -
    -

    The type-erased or otherwise mapped version of the value being held unowned.

    - -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Structs/WeakErased.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Structs/WeakErased.html deleted file mode 100644 index fb7d2d7b..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Structs/WeakErased.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - WeakErased Structure Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - WeakErased Structure Reference -

- -
- -
- -
-
-

WeakErased

-

WeakErased is a property wrapper to hold objects with a weak reference when using type-erasure.

- -

Create this wrapper using an initial value and a closure to create the type-erased object. -Make sure to not create a WeakErased wrapper for already type-erased objects, -since their reference is most likely instantly lost.

- -
-
- -
-
-
-
    -
  • -
    - - - - wrappedValue - -
    -
    -
    -
    -
    -
    -

    The type-erased or otherwise mapped version of the value being held weakly.

    - -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Typealiases.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Typealiases.html deleted file mode 100644 index c3f9b126..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/Typealiases.html +++ /dev/null @@ -1,760 +0,0 @@ - - - - Type Aliases Reference - - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - Type Aliases Reference -

- -
- -
- -
-
-

Type Aliases

-

The following type aliases are available globally.

- -
-
- -
-
-
- -
-
- -
-
-
    -
  • -
    - - - - PresentationHandler - -
    -
    -
    -
    -
    -
    -

    The completion handler for transitions.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public typealias PresentationHandler = () -> Void
    - -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    The completion handler for transitions, which also provides the context information about the transition.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public typealias ContextPresentationHandler = (TransitionContext) -> Void
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - NavigationTransition - -
    -
    -
    -
    -
    -
    -

    NavigationTransition offers transitions that can be used -with a UINavigationController as rootViewController.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public typealias NavigationTransition = Transition<UINavigationController>
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - PageTransition - -
    -
    -
    -
    -
    -
    -

    PageTransition offers transitions that can be used -with a UIPageViewController rootViewController.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public typealias PageTransition = Transition<UIPageViewController>
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - SplitTransition - -
    -
    -
    -
    -
    -
    -

    SplitTransition offers different transitions common to a UISplitViewController rootViewController.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public typealias SplitTransition = Transition<UISplitViewController>
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - TabBarTransition - -
    -
    -
    -
    -
    -
    -

    TabBarTransition offers transitions that can be used -with a UITabBarController rootViewController.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public typealias TabBarTransition = Transition<UITabBarController>
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - AnyRouter - -
    -
    -
    -
    -
    -
    -

    Please use StrongRouter, WeakRouter or UnownedRouter instead.

    -
    -

    Note

    - Use a StrongRouter, if you need to hold a router even -when it is not in the view hierarchy. -Use a WeakRouter or UnownedRouter when you are accessing -any router from the view hierarchy. - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    @available(iOS, deprecated)
-public typealias AnyRouter<RouteType> = UnownedRouter<RouteType> where RouteType : Route
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - UnownedRouter - -
    -
    -
    -
    -
    -
    -

    An UnownedRouter is an unowned version of a router object to be used in view controllers or view models.

    -
    -

    Note

    - Do not create an UnownedRouter from a StrongRouter since StrongRouter is only another wrapper -and does not represent the might instantly - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public typealias UnownedRouter<RouteType> = UnownedErased<StrongRouter<RouteType>> where RouteType : Route
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - ViewTransition - -
    -
    -
    -
    -
    -
    -

    ViewTransition offers transitions common to any UIViewController rootViewController.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public typealias ViewTransition = Transition<UIViewController>
    - -
    -
    -
    -
    -
    • -
-
-
-
    -
  • -
    - - - - WeakRouter - -
    -
    -
    -
    -
    -
    -

    A WeakRouter is a weak version of a router object to be used in view controllers or view models.

    -
    -

    Note

    - Do not create a WeakRouter from a StrongRouter since StrongRouter is only another wrapper -and does not represent the might instantly. -Also keep in mind that once the original router object has been deallocated, -calling trigger on this wrapper will have no effect. - -
    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public typealias WeakRouter<RouteType> = WeakErased<StrongRouter<RouteType>> where RouteType : Route
    - -
    -
    -
    -
    -
    • -
-
-
-
- -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/css/highlight.css b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/css/highlight.css deleted file mode 100644 index d0db0e13..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/css/highlight.css +++ /dev/null @@ -1,200 +0,0 @@ -/* Credit to https://gist.github.com/wataru420/2048287 */ -.highlight { - /* Comment */ - /* Error */ - /* Keyword */ - /* Operator */ - /* Comment.Multiline */ - /* Comment.Preproc */ - /* Comment.Single */ - /* Comment.Special */ - /* Generic.Deleted */ - /* Generic.Deleted.Specific */ - /* Generic.Emph */ - /* Generic.Error */ - /* Generic.Heading */ - /* Generic.Inserted */ - /* Generic.Inserted.Specific */ - /* Generic.Output */ - /* Generic.Prompt */ - /* Generic.Strong */ - /* Generic.Subheading */ - /* Generic.Traceback */ - /* Keyword.Constant */ - /* Keyword.Declaration */ - /* Keyword.Pseudo */ - /* Keyword.Reserved */ - /* Keyword.Type */ - /* Literal.Number */ - /* Literal.String */ - /* Name.Attribute */ - /* Name.Builtin */ - /* Name.Class */ - /* Name.Constant */ - /* Name.Entity */ - /* Name.Exception */ - /* Name.Function */ - /* Name.Namespace */ - /* Name.Tag */ - /* Name.Variable */ - /* Operator.Word */ - /* Text.Whitespace */ - /* Literal.Number.Float */ - /* Literal.Number.Hex */ - /* Literal.Number.Integer */ - /* Literal.Number.Oct */ - /* Literal.String.Backtick */ - /* Literal.String.Char */ - /* Literal.String.Doc */ - /* Literal.String.Double */ - /* Literal.String.Escape */ - /* Literal.String.Heredoc */ - /* Literal.String.Interpol */ - /* Literal.String.Other */ - /* Literal.String.Regex */ - /* Literal.String.Single */ - /* Literal.String.Symbol */ - /* Name.Builtin.Pseudo */ - /* Name.Variable.Class */ - /* Name.Variable.Global */ - /* Name.Variable.Instance */ - /* Literal.Number.Integer.Long */ } - .highlight .c { - color: #999988; - font-style: italic; } - .highlight .err { - color: #a61717; - background-color: #e3d2d2; } - .highlight .k { - color: #000000; - font-weight: bold; } - .highlight .o { - color: #000000; - font-weight: bold; } - .highlight .cm { - color: #999988; - font-style: italic; } - .highlight .cp { - color: #999999; - font-weight: bold; } - .highlight .c1 { - color: #999988; - font-style: italic; } - .highlight .cs { - color: #999999; - font-weight: bold; - font-style: italic; } - .highlight .gd { - color: #000000; - background-color: #ffdddd; } - .highlight .gd .x { - color: #000000; - background-color: #ffaaaa; } - .highlight .ge { - color: #000000; - font-style: italic; } - .highlight .gr { - color: #aa0000; } - .highlight .gh { - color: #999999; } - .highlight .gi { - color: #000000; - background-color: #ddffdd; } - .highlight .gi .x { - color: #000000; - background-color: #aaffaa; } - .highlight .go { - color: #888888; } - .highlight .gp { - color: #555555; } - .highlight .gs { - font-weight: bold; } - .highlight .gu { - color: #aaaaaa; } - .highlight .gt { - color: #aa0000; } - .highlight .kc { - color: #000000; - font-weight: bold; } - .highlight .kd { - color: #000000; - font-weight: bold; } - .highlight .kp { - color: #000000; - font-weight: bold; } - .highlight .kr { - color: #000000; - font-weight: bold; } - .highlight .kt { - color: #445588; } - .highlight .m { - color: #009999; } - .highlight .s { - color: #d14; } - .highlight .na { - color: #008080; } - .highlight .nb { - color: #0086B3; } - .highlight .nc { - color: #445588; - font-weight: bold; } - .highlight .no { - color: #008080; } - .highlight .ni { - color: #800080; } - .highlight .ne { - color: #990000; - font-weight: bold; } - .highlight .nf { - color: #990000; } - .highlight .nn { - color: #555555; } - .highlight .nt { - color: #000080; } - .highlight .nv { - color: #008080; } - .highlight .ow { - color: #000000; - font-weight: bold; } - .highlight .w { - color: #bbbbbb; } - .highlight .mf { - color: #009999; } - .highlight .mh { - color: #009999; } - .highlight .mi { - color: #009999; } - .highlight .mo { - color: #009999; } - .highlight .sb { - color: #d14; } - .highlight .sc { - color: #d14; } - .highlight .sd { - color: #d14; } - .highlight .s2 { - color: #d14; } - .highlight .se { - color: #d14; } - .highlight .sh { - color: #d14; } - .highlight .si { - color: #d14; } - .highlight .sx { - color: #d14; } - .highlight .sr { - color: #009926; } - .highlight .s1 { - color: #d14; } - .highlight .ss { - color: #990073; } - .highlight .bp { - color: #999999; } - .highlight .vc { - color: #008080; } - .highlight .vg { - color: #008080; } - .highlight .vi { - color: #008080; } - .highlight .il { - color: #009999; } diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/css/jazzy.css b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/css/jazzy.css deleted file mode 100644 index 833be0d2..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/css/jazzy.css +++ /dev/null @@ -1,378 +0,0 @@ -*, *:before, *:after { - box-sizing: inherit; } - -body { - margin: 0; - background: #fff; - color: #333; - font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif; - letter-spacing: .2px; - -webkit-font-smoothing: antialiased; - box-sizing: border-box; } - -h1 { - font-size: 2rem; - font-weight: 700; - margin: 1.275em 0 0.6em; } - -h2 { - font-size: 1.75rem; - font-weight: 700; - margin: 1.275em 0 0.3em; } - -h3 { - font-size: 1.5rem; - font-weight: 700; - margin: 1em 0 0.3em; } - -h4 { - font-size: 1.25rem; - font-weight: 700; - margin: 1.275em 0 0.85em; } - -h5 { - font-size: 1rem; - font-weight: 700; - margin: 1.275em 0 0.85em; } - -h6 { - font-size: 1rem; - font-weight: 700; - margin: 1.275em 0 0.85em; - color: #777; } - -p { - margin: 0 0 1em; } - -ul, ol { - padding: 0 0 0 2em; - margin: 0 0 0.85em; } - -blockquote { - margin: 0 0 0.85em; - padding: 0 15px; - color: #858585; - border-left: 4px solid #e5e5e5; } - -img { - max-width: 100%; } - -a { - color: #4183c4; - text-decoration: none; } - a:hover, a:focus { - outline: 0; - text-decoration: underline; } - a.discouraged { - text-decoration: line-through; } - a.discouraged:hover, a.discouraged:focus { - text-decoration: underline line-through; } - -table { - background: #fff; - width: 100%; - border-collapse: collapse; - border-spacing: 0; - overflow: auto; - margin: 0 0 0.85em; } - -tr:nth-child(2n) { - background-color: #fbfbfb; } - -th, td { - padding: 6px 13px; - border: 1px solid #ddd; } - -pre { - margin: 0 0 1.275em; - padding: .85em 1em; - overflow: auto; - background: #f7f7f7; - font-size: .85em; - font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace; } - -code { - font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace; } - -p > code, li > code { - background: #f7f7f7; - padding: .2em; } - p > code:before, p > code:after, li > code:before, li > code:after { - letter-spacing: -.2em; - content: "\00a0"; } - -pre code { - padding: 0; - white-space: pre; } - -.content-wrapper { - display: flex; - flex-direction: column; } - @media (min-width: 768px) { - .content-wrapper { - flex-direction: row; } } - -.header { - display: flex; - padding: 8px; - font-size: 0.875em; - background: #444; - color: #999; } - -.header-col { - margin: 0; - padding: 0 8px; } - -.header-col--primary { - flex: 1; } - -.header-link { - color: #fff; } - -.header-icon { - padding-right: 6px; - vertical-align: -4px; - height: 16px; } - -.breadcrumbs { - font-size: 0.875em; - padding: 8px 16px; - margin: 0; - background: #fbfbfb; - border-bottom: 1px solid #ddd; } - -.carat { - height: 10px; - margin: 0 5px; } - -.navigation { - order: 2; } - @media (min-width: 768px) { - .navigation { - order: 1; - width: 25%; - max-width: 300px; - padding-bottom: 64px; - overflow: hidden; - word-wrap: normal; - background: #fbfbfb; - border-right: 1px solid #ddd; } } - -.nav-groups { - list-style-type: none; - padding-left: 0; } - -.nav-group-name { - border-bottom: 1px solid #ddd; - padding: 8px 0 8px 16px; } - -.nav-group-name-link { - color: #333; } - -.nav-group-tasks { - margin: 8px 0; - padding: 0 0 0 8px; } - -.nav-group-task { - font-size: 1em; - list-style-type: none; - white-space: nowrap; } - -.nav-group-task-link { - color: #808080; } - -.main-content { - order: 1; } - @media (min-width: 768px) { - .main-content { - order: 2; - flex: 1; - padding-bottom: 60px; } } - -.section { - padding: 0 32px; - border-bottom: 1px solid #ddd; } - -.section-content { - max-width: 834px; - margin: 0 auto; - padding: 16px 0; } - -.section-name { - color: #666; - display: block; } - -.declaration .highlight { - overflow-x: initial; - padding: 8px 0; - margin: 0; - background-color: transparent; - border: none; } - -.task-group-section { - border-top: 1px solid #ddd; } - -.task-group { - padding-top: 0px; } - -.task-name-container a[name]:before { - content: ""; - display: block; } - -.item-container { - padding: 0; } - -.item { - padding-top: 8px; - width: 100%; - list-style-type: none; } - .item a[name]:before { - content: ""; - display: block; } - .item .token, .item .direct-link { - padding-left: 3px; - margin-left: 0px; - font-size: 1rem; } - .item .declaration-note { - font-size: .85em; - color: #808080; - font-style: italic; } - -.pointer-container { - border-bottom: 1px solid #ddd; - left: -23px; - padding-bottom: 13px; - position: relative; - width: 110%; } - -.pointer { - left: 21px; - top: 7px; - display: block; - position: absolute; - width: 12px; - height: 12px; - border-left: 1px solid #ddd; - border-top: 1px solid #ddd; - background: #fff; - transform: rotate(45deg); } - -.height-container { - display: none; - position: relative; - width: 100%; - overflow: hidden; } - .height-container .section { - background: #fff; - border: 1px solid #ddd; - border-top-width: 0; - padding-top: 10px; - padding-bottom: 5px; - padding: 8px 16px; } - -.aside, .language { - padding: 6px 12px; - margin: 12px 0; - border-left: 5px solid #dddddd; - overflow-y: hidden; } - .aside .aside-title, .language .aside-title { - font-size: 9px; - letter-spacing: 2px; - text-transform: uppercase; - padding-bottom: 0; - margin: 0; - color: #aaa; - -webkit-user-select: none; } - .aside p:last-child, .language p:last-child { - margin-bottom: 0; } - -.language { - border-left: 5px solid #cde9f4; } - .language .aside-title { - color: #4183c4; } - -.aside-warning, .aside-deprecated, .aside-unavailable { - border-left: 5px solid #ff6666; } - .aside-warning .aside-title, .aside-deprecated .aside-title, .aside-unavailable .aside-title { - color: #ff0000; } - -.graybox { - border-collapse: collapse; - width: 100%; } - .graybox p { - margin: 0; - word-break: break-word; - min-width: 50px; } - .graybox td { - border: 1px solid #ddd; - padding: 5px 25px 5px 10px; - vertical-align: middle; } - .graybox tr td:first-of-type { - text-align: right; - padding: 7px; - vertical-align: top; - word-break: normal; - width: 40px; } - -.slightly-smaller { - font-size: 0.9em; } - -.footer { - padding: 8px 16px; - background: #444; - color: #ddd; - font-size: 0.8em; } - .footer p { - margin: 8px 0; } - .footer a { - color: #fff; } - -html.dash .header, html.dash .breadcrumbs, html.dash .navigation { - display: none; } - -html.dash .height-container { - display: block; } - -form[role=search] input { - font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif; - font-size: 14px; - line-height: 24px; - padding: 0 10px; - margin: 0; - border: none; - border-radius: 1em; } - .loading form[role=search] input { - background: white url(../img/spinner.gif) center right 4px no-repeat; } - -form[role=search] .tt-menu { - margin: 0; - min-width: 300px; - background: #fbfbfb; - color: #333; - border: 1px solid #ddd; } - -form[role=search] .tt-highlight { - font-weight: bold; } - -form[role=search] .tt-suggestion { - font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif; - padding: 0 8px; } - form[role=search] .tt-suggestion span { - display: table-cell; - white-space: nowrap; } - form[role=search] .tt-suggestion .doc-parent-name { - width: 100%; - text-align: right; - font-weight: normal; - font-size: 0.9em; - padding-left: 16px; } - -form[role=search] .tt-suggestion:hover, -form[role=search] .tt-suggestion.tt-cursor { - cursor: pointer; - background-color: #4183c4; - color: #fff; } - -form[role=search] .tt-suggestion:hover .doc-parent-name, -form[role=search] .tt-suggestion.tt-cursor .doc-parent-name { - color: #fff; } diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/img/carat.png b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/img/carat.png deleted file mode 100755 index 29d2f7fd..00000000 Binary files a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/img/carat.png and /dev/null differ diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/img/dash.png b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/img/dash.png deleted file mode 100755 index 6f694c7a..00000000 Binary files a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/img/dash.png and /dev/null differ diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/img/gh.png b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/img/gh.png deleted file mode 100755 index 628da97c..00000000 Binary files a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/img/gh.png and /dev/null differ diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/img/spinner.gif b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/img/spinner.gif deleted file mode 100644 index e3038d0a..00000000 Binary files a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/img/spinner.gif and /dev/null differ diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/index.html b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/index.html deleted file mode 100644 index 5aecef32..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/index.html +++ /dev/null @@ -1,601 +0,0 @@ - - - - XCoordinator Reference - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - XCoordinator Reference -

- -
- -
- -
-
- -

- -

-

Build Status CocoaPods Compatible Carthage Compatible Documentation Platform License

- -

⚠️ We have recently released XCoordinator 2.0. Make sure to read this section before migrating. In general, please replace all AnyRouter by either UnownedRouter (in viewControllers, viewModels or references to parent coordinators) or StrongRouter in your AppDelegate or for references to child coordinators. In addition to that, the rootViewController is now injected into the initializer instead of being created in the Coordinator.generateRootViewController method.

- -

“How does an app transition from one view controller to another?”. -This question is common and puzzling regarding iOS development. There are many answers, as every architecture has different implementation variations. Some do it from within the implementation of a view controller, while some use a router/coordinator, an object connecting view models.

- -

To better answer the question, we are building XCoordinator, a navigation framework based on the Coordinator pattern. -It’s especially useful for implementing MVVM-C, Model-View-ViewModel-Coordinator:

- -

- -

-

🏃‍♂️Getting started

- -

Create an enum with all of the navigation paths for a particular flow, i.e. a group of closely connected scenes. (It is up to you when to create a Route/Coordinator. As our rule of thumb, create a new Route/Coordinator whenever a new root view controller, e.g. a new navigation controller or a tab bar controller, is needed.).

- -

Whereas the Route describes which routes can be triggered in a flow, the Coordinator is responsible for the preparation of transitions based on routes being triggered. We could, therefore, prepare multiple coordinators for the same route, which differ in which transitions are executed for each route.

- -

In the following example, we create the UserListRoute enum to define triggers of a flow of our application. UserListRoute offers routes to open the home screen, display a list of users, to open a specific user and to log out. The UserListCoordinator is implemented to prepare transitions for the triggered routes. When a UserListCoordinator is shown, it triggers the .home route to display a HomeViewController.

-
enum UserListRoute: Route {
-    case home
-    case users
-    case user(String)
-    case registerUsersPeek(from: Container)
-    case logout
-}
-
-class UserListCoordinator: NavigationCoordinator<UserListRoute> {
-    init() {
-        super.init(initialRoute: .home)
-    }
-
-    override func prepareTransition(for route: UserListRoute) -> NavigationTransition {
-        switch route {
-        case .home:
-            let viewController = HomeViewController.instantiateFromNib()
-            let viewModel = HomeViewModelImpl(router: anyRouter)
-            viewController.bind(to: viewModel)
-            return .push(viewController)
-        case .users:
-            let viewController = UsersViewController.instantiateFromNib()
-            let viewModel = UsersViewModelImpl(router: anyRouter)
-            viewController.bind(to: viewModel)
-            return .push(viewController, animation: .interactiveFade)
-        case .user(let username):
-            let coordinator = UserCoordinator(user: username)
-            return .present(coordinator, animation: .default)
-        case .registerUsersPeek(let source):
-            return registerPeek(for: source, route: .users)
-        case .logout:
-            return .dismiss()
-        }
-    }
-}
-
- -

Routes are triggered from within Coordinators or ViewModels. In the following, we describe how to trigger routes from within a ViewModel. The router of the current flow is injected into the ViewModel.

-
class HomeViewModel {
-    let router: UnownedRouter<HomeRoute>
-
-    init(router: UnownedRouter<HomeRoute>) {
-        self.router = router
-    }
-
-    /* ... */
-
-    func usersButtonPressed() {
-        router.trigger(.users)
-    }
-}
-
-

🏗 Organizing an app’s structure with XCoordinator

- -

In general, an app’s structure is defined by nesting coordinators and view controllers. You can transition (i.e. push, present, pop, dismiss) to a different coordinator whenever your app changes to a different flow. Within a flow, we transition between viewControllers.

- -

Example: In UserListCoordinator.prepareTransition(for:) we change from the UserListRoute to the UserRoute whenever the UserListRoute.user route is triggered. By dismissing a viewController in UserListRoute.logout, we additionally switch back to the previous flow - in this case the HomeRoute.

- -

To achieve this behavior, every Coordinator has its own rootViewController. This would be a UINavigationController in the case of a NavigationCoordinator, a UITabBarController in the case of a TabBarCoordinator, etc. When transitioning to a Coordinator/Router, this rootViewController is used as the destination view controller.

-

🏁 Using XCoordinator from App Launch

- -

To use coordinators from the launch of the app, make sure to create the app’s window programmatically in AppDelegate.swift (Don’t forget to remove Main Storyboard file base name from Info.plist). Then, set the coordinator as the root of the window‘s view hierarchy in the AppDelegate.didFinishLaunching. Make sure to hold a strong reference to your app’s initial coordinator or a strongRouter reference.

-
@UIApplicationMain
-class AppDelegate: UIResponder, UIApplicationDelegate {
-    let window: UIWindow! = UIWindow()
-    let router = AppCoordinator().strongRouter
-
-    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
-        router.setRoot(for: window)
-        return true
-    }
-}
-
-

🤸‍♂️ Extras

- -

For more advanced use, XCoordinator offers many more customization options. We introduce custom animated transitions and deep linking. Furthermore, extensions for use in reactive programming with RxSwift/Combine and options to split up huge routes are described.

-

🌗 Custom Transitions

- -

Custom animated transitions define presentation and dismissal animations. You can specify Animation objects in prepareTransition(for:) in your coordinator for several common transitions, such as present, dismiss, push and pop. Specifying no animation (nil) results in not overriding previously set animations. Use Animation.default to reset previously set animation to the default animations UIKit offers.

-
class UsersCoordinator: NavigationCoordinator<UserRoute> {
-
-    /* ... */
-
-    override func prepareTransition(for route: UserRoute) -> NavigationTransition {
-        switch route {
-        case .user(let name):
-            let animation = Animation(
-                presentationAnimation: YourAwesomePresentationTransitionAnimation(),
-                dismissalAnimation: YourAwesomeDismissalTransitionAnimation()
-            )
-            let viewController = UserViewController.instantiateFromNib()
-            let viewModel = UserViewModelImpl(coordinator: coordinator, name: name)
-            viewController.bind(to: viewModel)
-            return .push(viewController, animation: animation)
-        /* ... */
-        }
-    }
-}
-
-

🛤 Deep Linking

- -

Deep Linking can be used to chain different routes together. In contrast to the .multiple transition, deep linking can identify routers based on previous transitions (e.g. when pushing or presenting a router), which enables chaining of routes of different types. Keep in mind, that you cannot access higher-level routers anymore once you trigger a route on a lower level of the router hierarchy.

-
class AppCoordinator: NavigationCoordinator<AppRoute> {
-
-    /* ... */
-
-    override func prepareTransition(for route: AppRoute) -> NavigationTransition {
-        switch route {
-        /* ... */
-        case .deep:
-            return deepLink(AppRoute.login, AppRoute.home, HomeRoute.news, HomeRoute.dismiss)
-        }
-    }
-}
-
- -

⚠️ XCoordinator does not check at compile-time, whether a deep link can be executed. Rather it uses assertionFailures to inform about incorrect chaining at runtime, when it cannot find an appriopriate router for a given route. Keep this in mind when changing the structure of your app.

-

🚏 RedirectionRouter

- -

Let’s assume, there is a route type called HugeRoute with more than 10 routes. To decrease coupling, HugeRoute needs to be split up into mutliple route types. As you will discover, many routes in HugeRoute use transitions dependent on a specific rootViewController, such as push, show, pop, etc. If splitting up routes by introducing a new router/coordinator is not an option, XCoordinator has two solutions for you to solve such a case: RedirectionRouter or using multiple coordinators with the same rootViewController (see this section for more information).

- -

A RedirectionRouter can be used to map a new route type onto a generalized ParentRoute. A RedirectionRouter is independent of the TransitionType of its parent router. You can use RedirectionRouter.init(viewController:parent:map:) or subclassing by overriding mapToParentRoute(_:) to create a RedirectionRouter.

- -

The following code example illustrates how a RedirectionRouter is initialized and used.

-
class ParentCoordinator: NavigationCoordinator<ParentRoute> {
-    /* ... */
-
-    override func prepareTransition(for route: ParentRoute) -> NavigationTransition {
-        switch route {
-        /* ... */
-        case .subCoordinator:
-            let subCoordinator = SubCoordinator(parent: unownedRouter)
-            return .push(subCoordinator)
-        }
-    }
-}
-
-class ChildCoordinator: RedirectionRouter<ParentRoute, ChildRoute> {
-    init(parent: UnownedRouter<ParentRoute>) {
-        let viewController = UIViewController() 
-        // this viewController is used when performing transitions with the Subcoordinator directly.
-        super.init(viewController: viewController, parent: parent, map: nil)
-    }
-
-    /* ... */
-
-    override func mapToSuperRoute(for route: ChildRoute) -> ParentRoute {
-        // you can map your ChildRoute enum to ParentRoute cases here that will get triggered on the parent router.
-    }
-}
-
-

🚏Using multiple coordinators with the same rootViewController

- -

With XCoordinator 2.0, we introduce the option to use different coordinators with the same rootViewController. -Since you can specify the rootViewController in the initializer of a new coordinator, you can specify an existing coordinator’s rootViewController as in the following:

-
class FirstCoordinator: NavigationCoordinator<FirstRoute> {
-    /* ... */
-
-    override func prepareTransition(for route: FirstRoute) -> NavigationTransition {
-        switch route {
-        case .secondCoordinator:
-            let secondCoordinator = SecondCoordinator(rootViewController: self.rootViewController)
-            addChild(secondCoordinator)
-            return .none() 
-            // you could also trigger a specific initial route at this point, 
-            // such as `.trigger(SecondRoute.initial, on: secondCoordinator)`
-        }
-    }
-}
-
- -

We suggest to not use initial routes in the initializers of sibling coordinators, but instead using the transition option in the FirstCoordinator instead.

- -

⚠️ If you perform transitions involving a sibling coordinator directly (e.g. pushing a sibling coordinator without overriding its viewController property), your app will most likely crash.

-

🚀 RxSwift/Combine extensions

- -

Reactive programming can be very useful to keep the state of view and model consistent in a MVVM architecture. Instead of relying on the completion handler of the trigger method available in any Router, you can also use our RxSwift-extension. In the example application, we use Actions (from the Action framework) to trigger routes on certain UI events - e.g. to trigger LoginRoute.home in LoginViewModel, when the login button is tapped.

-
class LoginViewModelImpl: LoginViewModel, LoginViewModelInput, LoginViewModelOutput {
-
-    private let router: UnownedRouter<AppRoute>
-
-    private lazy var loginAction = CocoaAction { [unowned self] in
-        return self.router.rx.trigger(.home)
-    }
-
-    /* ... */
-}
-
-
- -

In addition to the above-mentioned approach, the reactive trigger extension can also be used to sequence different transitions by using the flatMap operator, as can be seen in the following:

-
let doneWithBothTransitions = 
-    router.rx.trigger(.home)
-        .flatMap { [unowned router] in router.rx.trigger(.news) }
-        .map { true }
-        .startWith(false)
-
- -

When using XCoordinator with the Combine extensions, you can use router.publishers.trigger instead of router.rx.trigger.

-

📚 Documentation & Example app

- -

To get more information about XCoordinator, check out the documentation. -Additionally, this repository serves as an example project using a MVVM architecture with XCoordinator.

- -

For a MVC example app, have a look at a workshop we did with a previous version of XCoordinator.

-

👨‍✈️ Why coordinators

- -
    -
  • Separation of responsibilities with the coordinator being the only component knowing anything related to the flow of your application.
    • -
  • Reusable Views and ViewModels because they do not contain any navigation logic.
    • -

  • Less coupling between components

    • -

  • Changeable navigation: Each coordinator is only responsible for one component and does not need to make assumptions about its parent. It can therefore be placed wherever we want to.

    • -
- -
-

The Coordinator by Soroush Khanlou

-
-

⁉️ Why XCoordinator

- -
    -
  • Actual navigation code is already written and abstracted away.
    • -
  • Clear separation of concerns: - -
      -
    • Coordinator: Coordinates routing of a set of routes.
      • -
    • Route: Describes navigation path.
      • -
    • Transition: Describe transition type and animation to new view.
      • -
    • -
  • Reuse coordinators, routers and transitions in different combinations.
    • -
  • Full support for custom transitions/animations.
    • -
  • Support for embedding child views / container views.
    • -
  • Generic BasicCoordinator classes suitable for many use cases and therefore less need to write your own coordinators.
    • -
  • Full support for your own coordinator classes conforming to our Coordinator protocol - -
    • -
  • Generic AnyRouter type erasure class encapsulates all types of coordinators and routers supporting the same set of routes. Therefore you can easily replace coordinators.
    • -
  • Use of enum for routes gives you autocompletion and type safety to perform only transition to routes supported by the coordinator.
    • -
-

🔩 Components

-

🎢 Route

- -

Describes possible navigation paths within a flow, a collection of closely related scenes.

-

👨‍✈️ Coordinator / Router

- -

An object loading views and creating viewModels based on triggered routes. A Coordinator creates and performs transitions to these scenes based on the data transferred via the route. In contrast to the coordinator, a router can be seen as an abstraction from that concept limited to triggering routes. Often, a Router is used to abstract from a specific coordinator in ViewModels.

-

When to use which Router abstraction

- -

You can create different router abstractions using the unownedRouter, weakRouter or strongRouter properties of your Coordinator. -You can decide between the following router abstractions of your coordinator:

- -
    -
  • StrongRouter holds a strong reference to the original coordinator. You can use this to hold child coordinators or to specify a certain router in the AppDelegate.
    • -
  • WeakRouter holds a weak reference to the original coordinator. You can use this to hold a coordinator in a viewController or viewModel. It can also be used to keep a reference to a sibling or parent coordinator.
    • -
  • UnownedRouter holds an unowned reference to the original coordinator. You can use this to hold a coordinator in a viewController or viewModel. It can also be used to keep a reference to a sibling or parent coordinator.
    • -
- -

If you want to know more about the differences on how references can be held, have a look here.

-

🌗 Transition

- -

Transitions describe the navigation from one view to another. Transitions are available based on the type of the root view controller in use. Example: Whereas ViewTransition only supports basic transitions that every root view controller supports, NavigationTransition adds navigation controller specific transitions.

- -

The available transition types include:

- -
    -
  • present presents a view controller on top of the view hierarchy - use presentOnRoot in case you want to present from the root view controller
    • -
  • embed embeds a view controller into a container view
    • -
  • dismiss dismisses the top most presented view controller - use dismissToRoot to call dismiss on the root view controller
    • -
  • none does nothing, may be used to ignore routes or for testing purposes
    • -
  • push pushes a view controller to the navigation stack (only in NavigationTransition)
    • -
  • pop pops the top view controller from the navigation stack (only in NavigationTransition)
    • -
  • popToRoot pops all the view controllers on the navigation stack except the root view controller (only in NavigationTransition)
    • -
- -

XCoordinator additionally supports common transitions for UITabBarController, UISplitViewController and UIPageViewController root view controllers.

-

🛠 Installation

-

CocoaPods

- -

To integrate XCoordinator into your Xcode project using CocoaPods, add this to your Podfile:

-
pod 'XCoordinator', '~> 2.0'
-
- -

To use the RxSwift extensions, add this to your Podfile:

-
pod 'XCoordinator/RxSwift', '~> 2.0'
-
- -

To use the Combine extensions, add this to your Podfile:

-
pod 'XCoordinator/Combine', '~> 2.0'
-
-

Carthage

- -

To integrate XCoordinator into your Xcode project using Carthage, add this to your Cartfile:

-
github "quickbirdstudios/XCoordinator" ~> 2.0
-
- -

Then run carthage update.

- -

If this is your first time using Carthage in the project, you’ll need to go through some additional steps as explained over at Carthage.

-

Swift Package Manager

- -

See this WWDC presentation about more information how to adopt Swift packages in your app.

- -

Specify https://github.com/quickbirdstudios/XCoordinator.git as the XCoordinator package link. -You can then decide between three different frameworks, i.e. XCoordinator, XCoordinatorRx and XCoordinatorCombine. -While XCoordinator contains the main framework, you can choose XCoordinatorRx or XCoordinatorCombine to get RxSwift or Combine extensions as well.

-

Manually

- -

If you prefer not to use any of the dependency managers, you can integrate XCoordinator into your project manually, by downloading the source code and placing the files on your project directory.

-

👤 Author

- -

This framework is created with ❤️ by QuickBird Studios.

- -

To get more information on XCoordinator check out our blog post.

-

❤️ Contributing

- -

Open an issue if you need help, if you found a bug, or if you want to discuss a feature request. If you feel like having a chat about XCoordinator with the developers and other users, join our Slack Workspace.

- -

Open a PR if you want to make changes to XCoordinator.

-

📃 License

- -

XCoordinator is released under an MIT license. See License.md for more information.

- -
-
- - -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- - - diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/js/jazzy.js b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/js/jazzy.js deleted file mode 100755 index c31dc05e..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/js/jazzy.js +++ /dev/null @@ -1,59 +0,0 @@ -window.jazzy = {'docset': false} -if (typeof window.dash != 'undefined') { - document.documentElement.className += ' dash' - window.jazzy.docset = true -} -if (navigator.userAgent.match(/xcode/i)) { - document.documentElement.className += ' xcode' - window.jazzy.docset = true -} - -function toggleItem($link, $content) { - var animationDuration = 300; - $link.toggleClass('token-open'); - $content.slideToggle(animationDuration); -} - -function itemLinkToContent($link) { - return $link.parent().parent().next(); -} - -// On doc load + hash-change, open any targetted item -function openCurrentItemIfClosed() { - if (window.jazzy.docset) { - return; - } - var $link = $(`.token[href="${location.hash}"]`); - $content = itemLinkToContent($link); - if ($content.is(':hidden')) { - toggleItem($link, $content); - } -} - -$(openCurrentItemIfClosed); -$(window).on('hashchange', openCurrentItemIfClosed); - -// On item link ('token') click, toggle its discussion -$('.token').on('click', function(event) { - if (window.jazzy.docset) { - return; - } - var $link = $(this); - toggleItem($link, itemLinkToContent($link)); - - // Keeps the document from jumping to the hash. - var href = $link.attr('href'); - if (history.pushState) { - history.pushState({}, '', href); - } else { - location.hash = href; - } - event.preventDefault(); -}); - -// Clicks on links to the current, closed, item need to open the item -$("a:not('.token')").on('click', function() { - if (location == this.href) { - openCurrentItemIfClosed(); - } -}); diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/js/jazzy.search.js b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/js/jazzy.search.js deleted file mode 100644 index e3d1ab90..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/js/jazzy.search.js +++ /dev/null @@ -1,70 +0,0 @@ -$(function(){ - var $typeahead = $('[data-typeahead]'); - var $form = $typeahead.parents('form'); - var searchURL = $form.attr('action'); - - function displayTemplate(result) { - return result.name; - } - - function suggestionTemplate(result) { - var t = '
'; - t += '' + result.name + ''; - if (result.parent_name) { - t += '' + result.parent_name + ''; - } - t += '
'; - return t; - } - - $typeahead.one('focus', function() { - $form.addClass('loading'); - - $.getJSON(searchURL).then(function(searchData) { - const searchIndex = lunr(function() { - this.ref('url'); - this.field('name'); - this.field('abstract'); - for (const [url, doc] of Object.entries(searchData)) { - this.add({url: url, name: doc.name, abstract: doc.abstract}); - } - }); - - $typeahead.typeahead( - { - highlight: true, - minLength: 3, - autoselect: true - }, - { - limit: 10, - display: displayTemplate, - templates: { suggestion: suggestionTemplate }, - source: function(query, sync) { - const lcSearch = query.toLowerCase(); - const results = searchIndex.query(function(q) { - q.term(lcSearch, { boost: 100 }); - q.term(lcSearch, { - boost: 10, - wildcard: lunr.Query.wildcard.TRAILING - }); - }).map(function(result) { - var doc = searchData[result.ref]; - doc.url = result.ref; - return doc; - }); - sync(results); - } - } - ); - $form.removeClass('loading'); - $typeahead.trigger('focus'); - }); - }); - - var baseURL = searchURL.slice(0, -"search.json".length); - - $typeahead.on('typeahead:select', function(e, result) { - window.location = baseURL + result.url; - }); -}); diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/js/jquery.min.js b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/js/jquery.min.js deleted file mode 100644 index a1c07fd8..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/js/jquery.min.js +++ /dev/null @@ -1,2 +0,0 @@ -/*! jQuery v3.4.1 | (c) JS Foundation and other contributors | jquery.org/license */ -!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],E=C.document,r=Object.getPrototypeOf,s=t.slice,g=t.concat,u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType},x=function(e){return null!=e&&e===e.window},c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.4.1",k=function(e,t){return new k.fn.init(e,t)},p=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g;function d(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp($),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+$),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\([\\da-f]{1,6}"+M+"?|("+M+")|.)","ig"),ne=function(e,t,n){var r="0x"+t-65536;return r!=r||n?t:r<0?String.fromCharCode(r+65536):String.fromCharCode(r>>10|55296,1023&r|56320)},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(m.childNodes),m.childNodes),t[m.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&((e?e.ownerDocument||e:m)!==C&&T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!A[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&U.test(t)){(s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=k),o=(l=h(t)).length;while(o--)l[o]="#"+s+" "+xe(l[o]);c=l.join(","),f=ee.test(t)&&ye(e.parentNode)||e}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){A(t,!0)}finally{s===k&&e.removeAttribute("id")}}}return g(t.replace(B,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[k]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e.namespaceURI,n=(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:m;return r!==C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),m!==C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=k,!C.getElementsByName||!C.getElementsByName(k).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+k+"-]").length||v.push("~="),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+k+"+*").length||v.push(".#.+[+~]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",$)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},D=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)===(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e===C||e.ownerDocument===m&&y(m,e)?-1:t===C||t.ownerDocument===m&&y(m,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e===C?-1:t===C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]===m?-1:s[r]===m?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if((e.ownerDocument||e)!==C&&T(e),d.matchesSelector&&E&&!A[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){A(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=p[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&p(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?k.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?k.grep(e,function(e){return e===n!==r}):"string"!=typeof n?k.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(k.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||q,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:L.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof k?t[0]:t,k.merge(this,k.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),D.test(r[1])&&k.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(k):k.makeArray(e,this)}).prototype=k.fn,q=k(E);var H=/^(?:parents|prev(?:Until|All))/,O={children:!0,contents:!0,next:!0,prev:!0};function P(e,t){while((e=e[t])&&1!==e.nodeType);return e}k.fn.extend({has:function(e){var t=k(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i,ge={option:[1,""],thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?k.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;nx",y.noCloneChecked=!!me.cloneNode(!0).lastChild.defaultValue;var Te=/^key/,Ce=/^(?:mouse|pointer|contextmenu|drag|drop)|click/,Ee=/^([^.]*)(?:\.(.+)|)/;function ke(){return!0}function Se(){return!1}function Ne(e,t){return e===function(){try{return E.activeElement}catch(e){}}()==("focus"===t)}function Ae(e,t,n,r,i,o){var a,s;if("object"==typeof t){for(s in"string"!=typeof n&&(r=r||n,n=void 0),t)Ae(e,s,n,r,t[s],o);return e}if(null==r&&null==i?(i=n,r=n=void 0):null==i&&("string"==typeof n?(i=r,r=void 0):(i=r,r=n,n=void 0)),!1===i)i=Se;else if(!i)return e;return 1===o&&(a=i,(i=function(e){return k().off(e),a.apply(this,arguments)}).guid=a.guid||(a.guid=k.guid++)),e.each(function(){k.event.add(this,t,i,r,n)})}function De(e,i,o){o?(Q.set(e,i,!1),k.event.add(e,i,{namespace:!1,handler:function(e){var t,n,r=Q.get(this,i);if(1&e.isTrigger&&this[i]){if(r.length)(k.event.special[i]||{}).delegateType&&e.stopPropagation();else if(r=s.call(arguments),Q.set(this,i,r),t=o(this,i),this[i](),r!==(n=Q.get(this,i))||t?Q.set(this,i,!1):n={},r!==n)return e.stopImmediatePropagation(),e.preventDefault(),n.value}else r.length&&(Q.set(this,i,{value:k.event.trigger(k.extend(r[0],k.Event.prototype),r.slice(1),this)}),e.stopImmediatePropagation())}})):void 0===Q.get(e,i)&&k.event.add(e,i,ke)}k.event={global:{},add:function(t,e,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Q.get(t);if(v){n.handler&&(n=(o=n).handler,i=o.selector),i&&k.find.matchesSelector(ie,i),n.guid||(n.guid=k.guid++),(u=v.events)||(u=v.events={}),(a=v.handle)||(a=v.handle=function(e){return"undefined"!=typeof k&&k.event.triggered!==e.type?k.event.dispatch.apply(t,arguments):void 0}),l=(e=(e||"").match(R)||[""]).length;while(l--)d=g=(s=Ee.exec(e[l])||[])[1],h=(s[2]||"").split(".").sort(),d&&(f=k.event.special[d]||{},d=(i?f.delegateType:f.bindType)||d,f=k.event.special[d]||{},c=k.extend({type:d,origType:g,data:r,handler:n,guid:n.guid,selector:i,needsContext:i&&k.expr.match.needsContext.test(i),namespace:h.join(".")},o),(p=u[d])||((p=u[d]=[]).delegateCount=0,f.setup&&!1!==f.setup.call(t,r,h,a)||t.addEventListener&&t.addEventListener(d,a)),f.add&&(f.add.call(t,c),c.handler.guid||(c.handler.guid=n.guid)),i?p.splice(p.delegateCount++,0,c):p.push(c),k.event.global[d]=!0)}},remove:function(e,t,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Q.hasData(e)&&Q.get(e);if(v&&(u=v.events)){l=(t=(t||"").match(R)||[""]).length;while(l--)if(d=g=(s=Ee.exec(t[l])||[])[1],h=(s[2]||"").split(".").sort(),d){f=k.event.special[d]||{},p=u[d=(r?f.delegateType:f.bindType)||d]||[],s=s[2]&&new RegExp("(^|\\.)"+h.join("\\.(?:.*\\.|)")+"(\\.|$)"),a=o=p.length;while(o--)c=p[o],!i&&g!==c.origType||n&&n.guid!==c.guid||s&&!s.test(c.namespace)||r&&r!==c.selector&&("**"!==r||!c.selector)||(p.splice(o,1),c.selector&&p.delegateCount--,f.remove&&f.remove.call(e,c));a&&!p.length&&(f.teardown&&!1!==f.teardown.call(e,h,v.handle)||k.removeEvent(e,d,v.handle),delete u[d])}else for(d in u)k.event.remove(e,d+t[l],n,r,!0);k.isEmptyObject(u)&&Q.remove(e,"handle events")}},dispatch:function(e){var t,n,r,i,o,a,s=k.event.fix(e),u=new Array(arguments.length),l=(Q.get(this,"events")||{})[s.type]||[],c=k.event.special[s.type]||{};for(u[0]=s,t=1;t\x20\t\r\n\f]*)[^>]*)\/>/gi,qe=/\s*$/g;function Oe(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&k(e).children("tbody")[0]||e}function Pe(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function Re(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Me(e,t){var n,r,i,o,a,s,u,l;if(1===t.nodeType){if(Q.hasData(e)&&(o=Q.access(e),a=Q.set(t,o),l=o.events))for(i in delete a.handle,a.events={},l)for(n=0,r=l[i].length;n")},clone:function(e,t,n){var r,i,o,a,s,u,l,c=e.cloneNode(!0),f=oe(e);if(!(y.noCloneChecked||1!==e.nodeType&&11!==e.nodeType||k.isXMLDoc(e)))for(a=ve(c),r=0,i=(o=ve(e)).length;r").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Vt,Gt=[],Yt=/(=)\?(?=&|$)|\?\?/;k.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Gt.pop()||k.expando+"_"+kt++;return this[e]=!0,e}}),k.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Yt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Yt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Yt,"$1"+r):!1!==e.jsonp&&(e.url+=(St.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||k.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?k(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Gt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((Vt=E.implementation.createHTMLDocument("").body).innerHTML="
",2===Vt.childNodes.length),k.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=D.exec(e))?[t.createElement(i[1])]:(i=we([e],t,o),o&&o.length&&k(o).remove(),k.merge([],i.childNodes)));var r,i,o},k.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(k.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},k.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){k.fn[t]=function(e){return this.on(t,e)}}),k.expr.pseudos.animated=function(t){return k.grep(k.timers,function(e){return t===e.elem}).length},k.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=k.css(e,"position"),c=k(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=k.css(e,"top"),u=k.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,k.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},k.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){k.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===k.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===k.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=k(e).offset()).top+=k.css(e,"borderTopWidth",!0),i.left+=k.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-k.css(r,"marginTop",!0),left:t.left-i.left-k.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===k.css(e,"position"))e=e.offsetParent;return e||ie})}}),k.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;k.fn[t]=function(e){return _(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),k.each(["top","left"],function(e,n){k.cssHooks[n]=ze(y.pixelPosition,function(e,t){if(t)return t=_e(e,n),$e.test(t)?k(e).position()[n]+"px":t})}),k.each({Height:"height",Width:"width"},function(a,s){k.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){k.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return _(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?k.css(e,t,i):k.style(e,t,n,i)},s,n?e:void 0,n)}})}),k.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){k.fn[n]=function(e,t){return 0=this.length)return z.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},z.QueryLexer.prototype.width=function(){return this.pos-this.start},z.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},z.QueryLexer.prototype.backup=function(){this.pos-=1},z.QueryLexer.prototype.acceptDigitRun=function(){for(var e,t;47<(t=(e=this.next()).charCodeAt(0))&&t<58;);e!=z.QueryLexer.EOS&&this.backup()},z.QueryLexer.prototype.more=function(){return this.pos', - menu: '
' - }; - } - function buildSelectors(classes) { - var selectors = {}; - _.each(classes, function(v, k) { - selectors[k] = "." + v; - }); - return selectors; - } - function buildCss() { - var css = { - wrapper: { - position: "relative", - display: "inline-block" - }, - hint: { - position: "absolute", - top: "0", - left: "0", - borderColor: "transparent", - boxShadow: "none", - opacity: "1" - }, - input: { - position: "relative", - verticalAlign: "top", - backgroundColor: "transparent" - }, - inputWithNoHint: { - position: "relative", - verticalAlign: "top" - }, - menu: { - position: "absolute", - top: "100%", - left: "0", - zIndex: "100", - display: "none" - }, - ltr: { - left: "0", - right: "auto" - }, - rtl: { - left: "auto", - right: " 0" - } - }; - if (_.isMsie()) { - _.mixin(css.input, { - backgroundImage: "url(data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)" - }); - } - return css; - } - }(); - var EventBus = function() { - "use strict"; - var namespace, deprecationMap; - namespace = "typeahead:"; - deprecationMap = { - render: "rendered", - cursorchange: "cursorchanged", - select: "selected", - autocomplete: "autocompleted" - }; - function EventBus(o) { - if (!o || !o.el) { - $.error("EventBus initialized without el"); - } - this.$el = $(o.el); - } - _.mixin(EventBus.prototype, { - _trigger: function(type, args) { - var $e = $.Event(namespace + type); - this.$el.trigger.call(this.$el, $e, args || []); - return $e; - }, - before: function(type) { - var args, $e; - args = [].slice.call(arguments, 1); - $e = this._trigger("before" + type, args); - return $e.isDefaultPrevented(); - }, - trigger: function(type) { - var deprecatedType; - this._trigger(type, [].slice.call(arguments, 1)); - if (deprecatedType = deprecationMap[type]) { - this._trigger(deprecatedType, [].slice.call(arguments, 1)); - } - } - }); - return EventBus; - }(); - var EventEmitter = function() { - "use strict"; - var splitter = /\s+/, nextTick = getNextTick(); - return { - onSync: onSync, - onAsync: onAsync, - off: off, - trigger: trigger - }; - function on(method, types, cb, context) { - var type; - if (!cb) { - return this; - } - types = types.split(splitter); - cb = context ? bindContext(cb, context) : cb; - this._callbacks = this._callbacks || {}; - while (type = types.shift()) { - this._callbacks[type] = this._callbacks[type] || { - sync: [], - async: [] - }; - this._callbacks[type][method].push(cb); - } - return this; - } - function onAsync(types, cb, context) { - return on.call(this, "async", types, cb, context); - } - function onSync(types, cb, context) { - return on.call(this, "sync", types, cb, context); - } - function off(types) { - var type; - if (!this._callbacks) { - return this; - } - types = types.split(splitter); - while (type = types.shift()) { - delete this._callbacks[type]; - } - return this; - } - function trigger(types) { - var type, callbacks, args, syncFlush, asyncFlush; - if (!this._callbacks) { - return this; - } - types = types.split(splitter); - args = [].slice.call(arguments, 1); - while ((type = types.shift()) && (callbacks = this._callbacks[type])) { - syncFlush = getFlush(callbacks.sync, this, [ type ].concat(args)); - asyncFlush = getFlush(callbacks.async, this, [ type ].concat(args)); - syncFlush() && nextTick(asyncFlush); - } - return this; - } - function getFlush(callbacks, context, args) { - return flush; - function flush() { - var cancelled; - for (var i = 0, len = callbacks.length; !cancelled && i < len; i += 1) { - cancelled = callbacks[i].apply(context, args) === false; - } - return !cancelled; - } - } - function getNextTick() { - var nextTickFn; - if (window.setImmediate) { - nextTickFn = function nextTickSetImmediate(fn) { - setImmediate(function() { - fn(); - }); - }; - } else { - nextTickFn = function nextTickSetTimeout(fn) { - setTimeout(function() { - fn(); - }, 0); - }; - } - return nextTickFn; - } - function bindContext(fn, context) { - return fn.bind ? fn.bind(context) : function() { - fn.apply(context, [].slice.call(arguments, 0)); - }; - } - }(); - var highlight = function(doc) { - "use strict"; - var defaults = { - node: null, - pattern: null, - tagName: "strong", - className: null, - wordsOnly: false, - caseSensitive: false, - diacriticInsensitive: false - }; - var accented = { - A: "[AaªÀ-Åà-åĀ-ąǍǎȀ-ȃȦȧᴬᵃḀḁẚẠ-ảₐ℀℁℻⒜Ⓐⓐ㍱-㍴㎀-㎄㎈㎉㎩-㎯㏂㏊㏟㏿Ａａ]", - B: "[BbᴮᵇḂ-ḇℬ⒝Ⓑⓑ㍴㎅-㎇㏃㏈㏔㏝Ｂｂ]", - C: "[CcÇçĆ-čᶜ℀ℂ℃℅℆ℭⅭⅽ⒞Ⓒⓒ㍶㎈㎉㎝㎠㎤㏄-㏇Ｃｃ]", - D: "[DdĎďDŽ-džDZ-dzᴰᵈḊ-ḓⅅⅆⅮⅾ⒟Ⓓⓓ㋏㍲㍷-㍹㎗㎭-㎯㏅㏈Ｄｄ]", - E: "[EeÈ-Ëè-ëĒ-ěȄ-ȇȨȩᴱᵉḘ-ḛẸ-ẽₑ℡ℯℰⅇ⒠Ⓔⓔ㉐㋍㋎Ｅｅ]", - F: "[FfᶠḞḟ℉ℱ℻⒡Ⓕⓕ㎊-㎌㎙ff-fflＦｆ]", - G: "[GgĜ-ģǦǧǴǵᴳᵍḠḡℊ⒢Ⓖⓖ㋌㋍㎇㎍-㎏㎓㎬㏆㏉㏒㏿Ｇｇ]", - H: "[HhĤĥȞȟʰᴴḢ-ḫẖℋ-ℎ⒣Ⓗⓗ㋌㍱㎐-㎔㏊㏋㏗Ｈｈ]", - I: "[IiÌ-Ïì-ïĨ-İIJijǏǐȈ-ȋᴵᵢḬḭỈ-ịⁱℐℑℹⅈⅠ-ⅣⅥ-ⅨⅪⅫⅰ-ⅳⅵ-ⅸⅺⅻ⒤Ⓘⓘ㍺㏌㏕fiffiＩｉ]", - J: "[JjIJ-ĵLJ-njǰʲᴶⅉ⒥ⒿⓙⱼＪｊ]", - K: "[KkĶķǨǩᴷᵏḰ-ḵK⒦Ⓚⓚ㎄㎅㎉㎏㎑㎘㎞㎢㎦㎪㎸㎾㏀㏆㏍-㏏Ｋｋ]", - L: "[LlĹ-ŀLJ-ljˡᴸḶḷḺ-ḽℒℓ℡Ⅼⅼ⒧Ⓛⓛ㋏㎈㎉㏐-㏓㏕㏖㏿flfflＬｌ]", - M: "[MmᴹᵐḾ-ṃ℠™ℳⅯⅿ⒨Ⓜⓜ㍷-㍹㎃㎆㎎㎒㎖㎙-㎨㎫㎳㎷㎹㎽㎿㏁㏂㏎㏐㏔-㏖㏘㏙㏞㏟Ｍｍ]", - N: "[NnÑñŃ-ʼnNJ-njǸǹᴺṄ-ṋⁿℕ№⒩Ⓝⓝ㎁㎋㎚㎱㎵㎻㏌㏑Ｎｎ]", - O: "[OoºÒ-Öò-öŌ-őƠơǑǒǪǫȌ-ȏȮȯᴼᵒỌ-ỏₒ℅№ℴ⒪Ⓞⓞ㍵㏇㏒㏖Ｏｏ]", - P: "[PpᴾᵖṔ-ṗℙ⒫Ⓟⓟ㉐㍱㍶㎀㎊㎩-㎬㎰㎴㎺㏋㏗-㏚Ｐｐ]", - Q: "[Qqℚ⒬Ⓠⓠ㏃Ｑｑ]", - R: "[RrŔ-řȐ-ȓʳᴿᵣṘ-ṛṞṟ₨ℛ-ℝ⒭Ⓡⓡ㋍㍴㎭-㎯㏚㏛Ｒｒ]", - S: "[SsŚ-šſȘșˢṠ-ṣ₨℁℠⒮Ⓢⓢ㎧㎨㎮-㎳㏛㏜stＳｓ]", - T: "[TtŢ-ťȚțᵀᵗṪ-ṱẗ℡™⒯Ⓣⓣ㉐㋏㎔㏏ſtstＴｔ]", - U: "[UuÙ-Üù-üŨ-ųƯưǓǔȔ-ȗᵁᵘᵤṲ-ṷỤ-ủ℆⒰Ⓤⓤ㍳㍺Ｕｕ]", - V: "[VvᵛᵥṼ-ṿⅣ-Ⅷⅳ-ⅷ⒱Ⓥⓥⱽ㋎㍵㎴-㎹㏜㏞Ｖｖ]", - W: "[WwŴŵʷᵂẀ-ẉẘ⒲Ⓦⓦ㎺-㎿㏝Ｗｗ]", - X: "[XxˣẊ-ẍₓ℻Ⅸ-Ⅻⅸ-ⅻ⒳Ⓧⓧ㏓Ｘｘ]", - Y: "[YyÝýÿŶ-ŸȲȳʸẎẏẙỲ-ỹ⒴Ⓨⓨ㏉Ｙｙ]", - Z: "[ZzŹ-žDZ-dzᶻẐ-ẕℤℨ⒵Ⓩⓩ㎐-㎔Ｚｚ]" - }; - return function hightlight(o) { - var regex; - o = _.mixin({}, defaults, o); - if (!o.node || !o.pattern) { - return; - } - o.pattern = _.isArray(o.pattern) ? o.pattern : [ o.pattern ]; - regex = getRegex(o.pattern, o.caseSensitive, o.wordsOnly, o.diacriticInsensitive); - traverse(o.node, hightlightTextNode); - function hightlightTextNode(textNode) { - var match, patternNode, wrapperNode; - if (match = regex.exec(textNode.data)) { - wrapperNode = doc.createElement(o.tagName); - o.className && (wrapperNode.className = o.className); - patternNode = textNode.splitText(match.index); - patternNode.splitText(match[0].length); - wrapperNode.appendChild(patternNode.cloneNode(true)); - textNode.parentNode.replaceChild(wrapperNode, patternNode); - } - return !!match; - } - function traverse(el, hightlightTextNode) { - var childNode, TEXT_NODE_TYPE = 3; - for (var i = 0; i < el.childNodes.length; i++) { - childNode = el.childNodes[i]; - if (childNode.nodeType === TEXT_NODE_TYPE) { - i += hightlightTextNode(childNode) ? 1 : 0; - } else { - traverse(childNode, hightlightTextNode); - } - } - } - }; - function accent_replacer(chr) { - return accented[chr.toUpperCase()] || chr; - } - function getRegex(patterns, caseSensitive, wordsOnly, diacriticInsensitive) { - var escapedPatterns = [], regexStr; - for (var i = 0, len = patterns.length; i < len; i++) { - var escapedWord = _.escapeRegExChars(patterns[i]); - if (diacriticInsensitive) { - escapedWord = escapedWord.replace(/\S/g, accent_replacer); - } - escapedPatterns.push(escapedWord); - } - regexStr = wordsOnly ? "\\b(" + escapedPatterns.join("|") + ")\\b" : "(" + escapedPatterns.join("|") + ")"; - return caseSensitive ? new RegExp(regexStr) : new RegExp(regexStr, "i"); - } - }(window.document); - var Input = function() { - "use strict"; - var specialKeyCodeMap; - specialKeyCodeMap = { - 9: "tab", - 27: "esc", - 37: "left", - 39: "right", - 13: "enter", - 38: "up", - 40: "down" - }; - function Input(o, www) { - o = o || {}; - if (!o.input) { - $.error("input is missing"); - } - www.mixin(this); - this.$hint = $(o.hint); - this.$input = $(o.input); - this.$input.attr({ - "aria-activedescendant": "", - "aria-owns": this.$input.attr("id") + "_listbox", - role: "combobox", - "aria-readonly": "true", - "aria-autocomplete": "list" - }); - $(www.menu).attr("id", this.$input.attr("id") + "_listbox"); - this.query = this.$input.val(); - this.queryWhenFocused = this.hasFocus() ? this.query : null; - this.$overflowHelper = buildOverflowHelper(this.$input); - this._checkLanguageDirection(); - if (this.$hint.length === 0) { - this.setHint = this.getHint = this.clearHint = this.clearHintIfInvalid = _.noop; - } - this.onSync("cursorchange", this._updateDescendent); - } - Input.normalizeQuery = function(str) { - return _.toStr(str).replace(/^\s*/g, "").replace(/\s{2,}/g, " "); - }; - _.mixin(Input.prototype, EventEmitter, { - _onBlur: function onBlur() { - this.resetInputValue(); - this.trigger("blurred"); - }, - _onFocus: function onFocus() { - this.queryWhenFocused = this.query; - this.trigger("focused"); - }, - _onKeydown: function onKeydown($e) { - var keyName = specialKeyCodeMap[$e.which || $e.keyCode]; - this._managePreventDefault(keyName, $e); - if (keyName && this._shouldTrigger(keyName, $e)) { - this.trigger(keyName + "Keyed", $e); - } - }, - _onInput: function onInput() { - this._setQuery(this.getInputValue()); - this.clearHintIfInvalid(); - this._checkLanguageDirection(); - }, - _managePreventDefault: function managePreventDefault(keyName, $e) { - var preventDefault; - switch (keyName) { - case "up": - case "down": - preventDefault = !withModifier($e); - break; - - default: - preventDefault = false; - } - preventDefault && $e.preventDefault(); - }, - _shouldTrigger: function shouldTrigger(keyName, $e) { - var trigger; - switch (keyName) { - case "tab": - trigger = !withModifier($e); - break; - - default: - trigger = true; - } - return trigger; - }, - _checkLanguageDirection: function checkLanguageDirection() { - var dir = (this.$input.css("direction") || "ltr").toLowerCase(); - if (this.dir !== dir) { - this.dir = dir; - this.$hint.attr("dir", dir); - this.trigger("langDirChanged", dir); - } - }, - _setQuery: function setQuery(val, silent) { - var areEquivalent, hasDifferentWhitespace; - areEquivalent = areQueriesEquivalent(val, this.query); - hasDifferentWhitespace = areEquivalent ? this.query.length !== val.length : false; - this.query = val; - if (!silent && !areEquivalent) { - this.trigger("queryChanged", this.query); - } else if (!silent && hasDifferentWhitespace) { - this.trigger("whitespaceChanged", this.query); - } - }, - _updateDescendent: function updateDescendent(event, id) { - this.$input.attr("aria-activedescendant", id); - }, - bind: function() { - var that = this, onBlur, onFocus, onKeydown, onInput; - onBlur = _.bind(this._onBlur, this); - onFocus = _.bind(this._onFocus, this); - onKeydown = _.bind(this._onKeydown, this); - onInput = _.bind(this._onInput, this); - this.$input.on("blur.tt", onBlur).on("focus.tt", onFocus).on("keydown.tt", onKeydown); - if (!_.isMsie() || _.isMsie() > 9) { - this.$input.on("input.tt", onInput); - } else { - this.$input.on("keydown.tt keypress.tt cut.tt paste.tt", function($e) { - if (specialKeyCodeMap[$e.which || $e.keyCode]) { - return; - } - _.defer(_.bind(that._onInput, that, $e)); - }); - } - return this; - }, - focus: function focus() { - this.$input.focus(); - }, - blur: function blur() { - this.$input.blur(); - }, - getLangDir: function getLangDir() { - return this.dir; - }, - getQuery: function getQuery() { - return this.query || ""; - }, - setQuery: function setQuery(val, silent) { - this.setInputValue(val); - this._setQuery(val, silent); - }, - hasQueryChangedSinceLastFocus: function hasQueryChangedSinceLastFocus() { - return this.query !== this.queryWhenFocused; - }, - getInputValue: function getInputValue() { - return this.$input.val(); - }, - setInputValue: function setInputValue(value) { - this.$input.val(value); - this.clearHintIfInvalid(); - this._checkLanguageDirection(); - }, - resetInputValue: function resetInputValue() { - this.setInputValue(this.query); - }, - getHint: function getHint() { - return this.$hint.val(); - }, - setHint: function setHint(value) { - this.$hint.val(value); - }, - clearHint: function clearHint() { - this.setHint(""); - }, - clearHintIfInvalid: function clearHintIfInvalid() { - var val, hint, valIsPrefixOfHint, isValid; - val = this.getInputValue(); - hint = this.getHint(); - valIsPrefixOfHint = val !== hint && hint.indexOf(val) === 0; - isValid = val !== "" && valIsPrefixOfHint && !this.hasOverflow(); - !isValid && this.clearHint(); - }, - hasFocus: function hasFocus() { - return this.$input.is(":focus"); - }, - hasOverflow: function hasOverflow() { - var constraint = this.$input.width() - 2; - this.$overflowHelper.text(this.getInputValue()); - return this.$overflowHelper.width() >= constraint; - }, - isCursorAtEnd: function() { - var valueLength, selectionStart, range; - valueLength = this.$input.val().length; - selectionStart = this.$input[0].selectionStart; - if (_.isNumber(selectionStart)) { - return selectionStart === valueLength; - } else if (document.selection) { - range = document.selection.createRange(); - range.moveStart("character", -valueLength); - return valueLength === range.text.length; - } - return true; - }, - destroy: function destroy() { - this.$hint.off(".tt"); - this.$input.off(".tt"); - this.$overflowHelper.remove(); - this.$hint = this.$input = this.$overflowHelper = $("
"); - } - }); - return Input; - function buildOverflowHelper($input) { - return $('').css({ - position: "absolute", - visibility: "hidden", - whiteSpace: "pre", - fontFamily: $input.css("font-family"), - fontSize: $input.css("font-size"), - fontStyle: $input.css("font-style"), - fontVariant: $input.css("font-variant"), - fontWeight: $input.css("font-weight"), - wordSpacing: $input.css("word-spacing"), - letterSpacing: $input.css("letter-spacing"), - textIndent: $input.css("text-indent"), - textRendering: $input.css("text-rendering"), - textTransform: $input.css("text-transform") - }).insertAfter($input); - } - function areQueriesEquivalent(a, b) { - return Input.normalizeQuery(a) === Input.normalizeQuery(b); - } - function withModifier($e) { - return $e.altKey || $e.ctrlKey || $e.metaKey || $e.shiftKey; - } - }(); - var Dataset = function() { - "use strict"; - var keys, nameGenerator; - keys = { - dataset: "tt-selectable-dataset", - val: "tt-selectable-display", - obj: "tt-selectable-object" - }; - nameGenerator = _.getIdGenerator(); - function Dataset(o, www) { - o = o || {}; - o.templates = o.templates || {}; - o.templates.notFound = o.templates.notFound || o.templates.empty; - if (!o.source) { - $.error("missing source"); - } - if (!o.node) { - $.error("missing node"); - } - if (o.name && !isValidName(o.name)) { - $.error("invalid dataset name: " + o.name); - } - www.mixin(this); - this.highlight = !!o.highlight; - this.name = _.toStr(o.name || nameGenerator()); - this.limit = o.limit || 5; - this.displayFn = getDisplayFn(o.display || o.displayKey); - this.templates = getTemplates(o.templates, this.displayFn); - this.source = o.source.__ttAdapter ? o.source.__ttAdapter() : o.source; - this.async = _.isUndefined(o.async) ? this.source.length > 2 : !!o.async; - this._resetLastSuggestion(); - this.$el = $(o.node).attr("role", "presentation").addClass(this.classes.dataset).addClass(this.classes.dataset + "-" + this.name); - } - Dataset.extractData = function extractData(el) { - var $el = $(el); - if ($el.data(keys.obj)) { - return { - dataset: $el.data(keys.dataset) || "", - val: $el.data(keys.val) || "", - obj: $el.data(keys.obj) || null - }; - } - return null; - }; - _.mixin(Dataset.prototype, EventEmitter, { - _overwrite: function overwrite(query, suggestions) { - suggestions = suggestions || []; - if (suggestions.length) { - this._renderSuggestions(query, suggestions); - } else if (this.async && this.templates.pending) { - this._renderPending(query); - } else if (!this.async && this.templates.notFound) { - this._renderNotFound(query); - } else { - this._empty(); - } - this.trigger("rendered", suggestions, false, this.name); - }, - _append: function append(query, suggestions) { - suggestions = suggestions || []; - if (suggestions.length && this.$lastSuggestion.length) { - this._appendSuggestions(query, suggestions); - } else if (suggestions.length) { - this._renderSuggestions(query, suggestions); - } else if (!this.$lastSuggestion.length && this.templates.notFound) { - this._renderNotFound(query); - } - this.trigger("rendered", suggestions, true, this.name); - }, - _renderSuggestions: function renderSuggestions(query, suggestions) { - var $fragment; - $fragment = this._getSuggestionsFragment(query, suggestions); - this.$lastSuggestion = $fragment.children().last(); - this.$el.html($fragment).prepend(this._getHeader(query, suggestions)).append(this._getFooter(query, suggestions)); - }, - _appendSuggestions: function appendSuggestions(query, suggestions) { - var $fragment, $lastSuggestion; - $fragment = this._getSuggestionsFragment(query, suggestions); - $lastSuggestion = $fragment.children().last(); - this.$lastSuggestion.after($fragment); - this.$lastSuggestion = $lastSuggestion; - }, - _renderPending: function renderPending(query) { - var template = this.templates.pending; - this._resetLastSuggestion(); - template && this.$el.html(template({ - query: query, - dataset: this.name - })); - }, - _renderNotFound: function renderNotFound(query) { - var template = this.templates.notFound; - this._resetLastSuggestion(); - template && this.$el.html(template({ - query: query, - dataset: this.name - })); - }, - _empty: function empty() { - this.$el.empty(); - this._resetLastSuggestion(); - }, - _getSuggestionsFragment: function getSuggestionsFragment(query, suggestions) { - var that = this, fragment; - fragment = document.createDocumentFragment(); - _.each(suggestions, function getSuggestionNode(suggestion) { - var $el, context; - context = that._injectQuery(query, suggestion); - $el = $(that.templates.suggestion(context)).data(keys.dataset, that.name).data(keys.obj, suggestion).data(keys.val, that.displayFn(suggestion)).addClass(that.classes.suggestion + " " + that.classes.selectable); - fragment.appendChild($el[0]); - }); - this.highlight && highlight({ - className: this.classes.highlight, - node: fragment, - pattern: query - }); - return $(fragment); - }, - _getFooter: function getFooter(query, suggestions) { - return this.templates.footer ? this.templates.footer({ - query: query, - suggestions: suggestions, - dataset: this.name - }) : null; - }, - _getHeader: function getHeader(query, suggestions) { - return this.templates.header ? this.templates.header({ - query: query, - suggestions: suggestions, - dataset: this.name - }) : null; - }, - _resetLastSuggestion: function resetLastSuggestion() { - this.$lastSuggestion = $(); - }, - _injectQuery: function injectQuery(query, obj) { - return _.isObject(obj) ? _.mixin({ - _query: query - }, obj) : obj; - }, - update: function update(query) { - var that = this, canceled = false, syncCalled = false, rendered = 0; - this.cancel(); - this.cancel = function cancel() { - canceled = true; - that.cancel = $.noop; - that.async && that.trigger("asyncCanceled", query, that.name); - }; - this.source(query, sync, async); - !syncCalled && sync([]); - function sync(suggestions) { - if (syncCalled) { - return; - } - syncCalled = true; - suggestions = (suggestions || []).slice(0, that.limit); - rendered = suggestions.length; - that._overwrite(query, suggestions); - if (rendered < that.limit && that.async) { - that.trigger("asyncRequested", query, that.name); - } - } - function async(suggestions) { - suggestions = suggestions || []; - if (!canceled && rendered < that.limit) { - that.cancel = $.noop; - var idx = Math.abs(rendered - that.limit); - rendered += idx; - that._append(query, suggestions.slice(0, idx)); - that.async && that.trigger("asyncReceived", query, that.name); - } - } - }, - cancel: $.noop, - clear: function clear() { - this._empty(); - this.cancel(); - this.trigger("cleared"); - }, - isEmpty: function isEmpty() { - return this.$el.is(":empty"); - }, - destroy: function destroy() { - this.$el = $("
"); - } - }); - return Dataset; - function getDisplayFn(display) { - display = display || _.stringify; - return _.isFunction(display) ? display : displayFn; - function displayFn(obj) { - return obj[display]; - } - } - function getTemplates(templates, displayFn) { - return { - notFound: templates.notFound && _.templatify(templates.notFound), - pending: templates.pending && _.templatify(templates.pending), - header: templates.header && _.templatify(templates.header), - footer: templates.footer && _.templatify(templates.footer), - suggestion: templates.suggestion || suggestionTemplate - }; - function suggestionTemplate(context) { - return $('
').attr("id", _.guid()).text(displayFn(context)); - } - } - function isValidName(str) { - return /^[_a-zA-Z0-9-]+$/.test(str); - } - }(); - var Menu = function() { - "use strict"; - function Menu(o, www) { - var that = this; - o = o || {}; - if (!o.node) { - $.error("node is required"); - } - www.mixin(this); - this.$node = $(o.node); - this.query = null; - this.datasets = _.map(o.datasets, initializeDataset); - function initializeDataset(oDataset) { - var node = that.$node.find(oDataset.node).first(); - oDataset.node = node.length ? node : $("
").appendTo(that.$node); - return new Dataset(oDataset, www); - } - } - _.mixin(Menu.prototype, EventEmitter, { - _onSelectableClick: function onSelectableClick($e) { - this.trigger("selectableClicked", $($e.currentTarget)); - }, - _onRendered: function onRendered(type, dataset, suggestions, async) { - this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty()); - this.trigger("datasetRendered", dataset, suggestions, async); - }, - _onCleared: function onCleared() { - this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty()); - this.trigger("datasetCleared"); - }, - _propagate: function propagate() { - this.trigger.apply(this, arguments); - }, - _allDatasetsEmpty: function allDatasetsEmpty() { - return _.every(this.datasets, _.bind(function isDatasetEmpty(dataset) { - var isEmpty = dataset.isEmpty(); - this.$node.attr("aria-expanded", !isEmpty); - return isEmpty; - }, this)); - }, - _getSelectables: function getSelectables() { - return this.$node.find(this.selectors.selectable); - }, - _removeCursor: function _removeCursor() { - var $selectable = this.getActiveSelectable(); - $selectable && $selectable.removeClass(this.classes.cursor); - }, - _ensureVisible: function ensureVisible($el) { - var elTop, elBottom, nodeScrollTop, nodeHeight; - elTop = $el.position().top; - elBottom = elTop + $el.outerHeight(true); - nodeScrollTop = this.$node.scrollTop(); - nodeHeight = this.$node.height() + parseInt(this.$node.css("paddingTop"), 10) + parseInt(this.$node.css("paddingBottom"), 10); - if (elTop < 0) { - this.$node.scrollTop(nodeScrollTop + elTop); - } else if (nodeHeight < elBottom) { - this.$node.scrollTop(nodeScrollTop + (elBottom - nodeHeight)); - } - }, - bind: function() { - var that = this, onSelectableClick; - onSelectableClick = _.bind(this._onSelectableClick, this); - this.$node.on("click.tt", this.selectors.selectable, onSelectableClick); - this.$node.on("mouseover", this.selectors.selectable, function() { - that.setCursor($(this)); - }); - this.$node.on("mouseleave", function() { - that._removeCursor(); - }); - _.each(this.datasets, function(dataset) { - dataset.onSync("asyncRequested", that._propagate, that).onSync("asyncCanceled", that._propagate, that).onSync("asyncReceived", that._propagate, that).onSync("rendered", that._onRendered, that).onSync("cleared", that._onCleared, that); - }); - return this; - }, - isOpen: function isOpen() { - return this.$node.hasClass(this.classes.open); - }, - open: function open() { - this.$node.scrollTop(0); - this.$node.addClass(this.classes.open); - }, - close: function close() { - this.$node.attr("aria-expanded", false); - this.$node.removeClass(this.classes.open); - this._removeCursor(); - }, - setLanguageDirection: function setLanguageDirection(dir) { - this.$node.attr("dir", dir); - }, - selectableRelativeToCursor: function selectableRelativeToCursor(delta) { - var $selectables, $oldCursor, oldIndex, newIndex; - $oldCursor = this.getActiveSelectable(); - $selectables = this._getSelectables(); - oldIndex = $oldCursor ? $selectables.index($oldCursor) : -1; - newIndex = oldIndex + delta; - newIndex = (newIndex + 1) % ($selectables.length + 1) - 1; - newIndex = newIndex < -1 ? $selectables.length - 1 : newIndex; - return newIndex === -1 ? null : $selectables.eq(newIndex); - }, - setCursor: function setCursor($selectable) { - this._removeCursor(); - if ($selectable = $selectable && $selectable.first()) { - $selectable.addClass(this.classes.cursor); - this._ensureVisible($selectable); - } - }, - getSelectableData: function getSelectableData($el) { - return $el && $el.length ? Dataset.extractData($el) : null; - }, - getActiveSelectable: function getActiveSelectable() { - var $selectable = this._getSelectables().filter(this.selectors.cursor).first(); - return $selectable.length ? $selectable : null; - }, - getTopSelectable: function getTopSelectable() { - var $selectable = this._getSelectables().first(); - return $selectable.length ? $selectable : null; - }, - update: function update(query) { - var isValidUpdate = query !== this.query; - if (isValidUpdate) { - this.query = query; - _.each(this.datasets, updateDataset); - } - return isValidUpdate; - function updateDataset(dataset) { - dataset.update(query); - } - }, - empty: function empty() { - _.each(this.datasets, clearDataset); - this.query = null; - this.$node.addClass(this.classes.empty); - function clearDataset(dataset) { - dataset.clear(); - } - }, - destroy: function destroy() { - this.$node.off(".tt"); - this.$node = $("
"); - _.each(this.datasets, destroyDataset); - function destroyDataset(dataset) { - dataset.destroy(); - } - } - }); - return Menu; - }(); - var Status = function() { - "use strict"; - function Status(options) { - this.$el = $("", { - role: "status", - "aria-live": "polite" - }).css({ - position: "absolute", - padding: "0", - border: "0", - height: "1px", - width: "1px", - "margin-bottom": "-1px", - "margin-right": "-1px", - overflow: "hidden", - clip: "rect(0 0 0 0)", - "white-space": "nowrap" - }); - options.$input.after(this.$el); - _.each(options.menu.datasets, _.bind(function(dataset) { - if (dataset.onSync) { - dataset.onSync("rendered", _.bind(this.update, this)); - dataset.onSync("cleared", _.bind(this.cleared, this)); - } - }, this)); - } - _.mixin(Status.prototype, { - update: function update(event, suggestions) { - var length = suggestions.length; - var words; - if (length === 1) { - words = { - result: "result", - is: "is" - }; - } else { - words = { - result: "results", - is: "are" - }; - } - this.$el.text(length + " " + words.result + " " + words.is + " available, use up and down arrow keys to navigate."); - }, - cleared: function() { - this.$el.text(""); - } - }); - return Status; - }(); - var DefaultMenu = function() { - "use strict"; - var s = Menu.prototype; - function DefaultMenu() { - Menu.apply(this, [].slice.call(arguments, 0)); - } - _.mixin(DefaultMenu.prototype, Menu.prototype, { - open: function open() { - !this._allDatasetsEmpty() && this._show(); - return s.open.apply(this, [].slice.call(arguments, 0)); - }, - close: function close() { - this._hide(); - return s.close.apply(this, [].slice.call(arguments, 0)); - }, - _onRendered: function onRendered() { - if (this._allDatasetsEmpty()) { - this._hide(); - } else { - this.isOpen() && this._show(); - } - return s._onRendered.apply(this, [].slice.call(arguments, 0)); - }, - _onCleared: function onCleared() { - if (this._allDatasetsEmpty()) { - this._hide(); - } else { - this.isOpen() && this._show(); - } - return s._onCleared.apply(this, [].slice.call(arguments, 0)); - }, - setLanguageDirection: function setLanguageDirection(dir) { - this.$node.css(dir === "ltr" ? this.css.ltr : this.css.rtl); - return s.setLanguageDirection.apply(this, [].slice.call(arguments, 0)); - }, - _hide: function hide() { - this.$node.hide(); - }, - _show: function show() { - this.$node.css("display", "block"); - } - }); - return DefaultMenu; - }(); - var Typeahead = function() { - "use strict"; - function Typeahead(o, www) { - var onFocused, onBlurred, onEnterKeyed, onTabKeyed, onEscKeyed, onUpKeyed, onDownKeyed, onLeftKeyed, onRightKeyed, onQueryChanged, onWhitespaceChanged; - o = o || {}; - if (!o.input) { - $.error("missing input"); - } - if (!o.menu) { - $.error("missing menu"); - } - if (!o.eventBus) { - $.error("missing event bus"); - } - www.mixin(this); - this.eventBus = o.eventBus; - this.minLength = _.isNumber(o.minLength) ? o.minLength : 1; - this.input = o.input; - this.menu = o.menu; - this.enabled = true; - this.autoselect = !!o.autoselect; - this.active = false; - this.input.hasFocus() && this.activate(); - this.dir = this.input.getLangDir(); - this._hacks(); - this.menu.bind().onSync("selectableClicked", this._onSelectableClicked, this).onSync("asyncRequested", this._onAsyncRequested, this).onSync("asyncCanceled", this._onAsyncCanceled, this).onSync("asyncReceived", this._onAsyncReceived, this).onSync("datasetRendered", this._onDatasetRendered, this).onSync("datasetCleared", this._onDatasetCleared, this); - onFocused = c(this, "activate", "open", "_onFocused"); - onBlurred = c(this, "deactivate", "_onBlurred"); - onEnterKeyed = c(this, "isActive", "isOpen", "_onEnterKeyed"); - onTabKeyed = c(this, "isActive", "isOpen", "_onTabKeyed"); - onEscKeyed = c(this, "isActive", "_onEscKeyed"); - onUpKeyed = c(this, "isActive", "open", "_onUpKeyed"); - onDownKeyed = c(this, "isActive", "open", "_onDownKeyed"); - onLeftKeyed = c(this, "isActive", "isOpen", "_onLeftKeyed"); - onRightKeyed = c(this, "isActive", "isOpen", "_onRightKeyed"); - onQueryChanged = c(this, "_openIfActive", "_onQueryChanged"); - onWhitespaceChanged = c(this, "_openIfActive", "_onWhitespaceChanged"); - this.input.bind().onSync("focused", onFocused, this).onSync("blurred", onBlurred, this).onSync("enterKeyed", onEnterKeyed, this).onSync("tabKeyed", onTabKeyed, this).onSync("escKeyed", onEscKeyed, this).onSync("upKeyed", onUpKeyed, this).onSync("downKeyed", onDownKeyed, this).onSync("leftKeyed", onLeftKeyed, this).onSync("rightKeyed", onRightKeyed, this).onSync("queryChanged", onQueryChanged, this).onSync("whitespaceChanged", onWhitespaceChanged, this).onSync("langDirChanged", this._onLangDirChanged, this); - } - _.mixin(Typeahead.prototype, { - _hacks: function hacks() { - var $input, $menu; - $input = this.input.$input || $("
"); - $menu = this.menu.$node || $("
"); - $input.on("blur.tt", function($e) { - var active, isActive, hasActive; - active = document.activeElement; - isActive = $menu.is(active); - hasActive = $menu.has(active).length > 0; - if (_.isMsie() && (isActive || hasActive)) { - $e.preventDefault(); - $e.stopImmediatePropagation(); - _.defer(function() { - $input.focus(); - }); - } - }); - $menu.on("mousedown.tt", function($e) { - $e.preventDefault(); - }); - }, - _onSelectableClicked: function onSelectableClicked(type, $el) { - this.select($el); - }, - _onDatasetCleared: function onDatasetCleared() { - this._updateHint(); - }, - _onDatasetRendered: function onDatasetRendered(type, suggestions, async, dataset) { - this._updateHint(); - if (this.autoselect) { - var cursorClass = this.selectors.cursor.substr(1); - this.menu.$node.find(this.selectors.suggestion).first().addClass(cursorClass); - } - this.eventBus.trigger("render", suggestions, async, dataset); - }, - _onAsyncRequested: function onAsyncRequested(type, dataset, query) { - this.eventBus.trigger("asyncrequest", query, dataset); - }, - _onAsyncCanceled: function onAsyncCanceled(type, dataset, query) { - this.eventBus.trigger("asynccancel", query, dataset); - }, - _onAsyncReceived: function onAsyncReceived(type, dataset, query) { - this.eventBus.trigger("asyncreceive", query, dataset); - }, - _onFocused: function onFocused() { - this._minLengthMet() && this.menu.update(this.input.getQuery()); - }, - _onBlurred: function onBlurred() { - if (this.input.hasQueryChangedSinceLastFocus()) { - this.eventBus.trigger("change", this.input.getQuery()); - } - }, - _onEnterKeyed: function onEnterKeyed(type, $e) { - var $selectable; - if ($selectable = this.menu.getActiveSelectable()) { - if (this.select($selectable)) { - $e.preventDefault(); - $e.stopPropagation(); - } - } else if (this.autoselect) { - if (this.select(this.menu.getTopSelectable())) { - $e.preventDefault(); - $e.stopPropagation(); - } - } - }, - _onTabKeyed: function onTabKeyed(type, $e) { - var $selectable; - if ($selectable = this.menu.getActiveSelectable()) { - this.select($selectable) && $e.preventDefault(); - } else if ($selectable = this.menu.getTopSelectable()) { - this.autocomplete($selectable) && $e.preventDefault(); - } - }, - _onEscKeyed: function onEscKeyed() { - this.close(); - }, - _onUpKeyed: function onUpKeyed() { - this.moveCursor(-1); - }, - _onDownKeyed: function onDownKeyed() { - this.moveCursor(+1); - }, - _onLeftKeyed: function onLeftKeyed() { - if (this.dir === "rtl" && this.input.isCursorAtEnd()) { - this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable()); - } - }, - _onRightKeyed: function onRightKeyed() { - if (this.dir === "ltr" && this.input.isCursorAtEnd()) { - this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable()); - } - }, - _onQueryChanged: function onQueryChanged(e, query) { - this._minLengthMet(query) ? this.menu.update(query) : this.menu.empty(); - }, - _onWhitespaceChanged: function onWhitespaceChanged() { - this._updateHint(); - }, - _onLangDirChanged: function onLangDirChanged(e, dir) { - if (this.dir !== dir) { - this.dir = dir; - this.menu.setLanguageDirection(dir); - } - }, - _openIfActive: function openIfActive() { - this.isActive() && this.open(); - }, - _minLengthMet: function minLengthMet(query) { - query = _.isString(query) ? query : this.input.getQuery() || ""; - return query.length >= this.minLength; - }, - _updateHint: function updateHint() { - var $selectable, data, val, query, escapedQuery, frontMatchRegEx, match; - $selectable = this.menu.getTopSelectable(); - data = this.menu.getSelectableData($selectable); - val = this.input.getInputValue(); - if (data && !_.isBlankString(val) && !this.input.hasOverflow()) { - query = Input.normalizeQuery(val); - escapedQuery = _.escapeRegExChars(query); - frontMatchRegEx = new RegExp("^(?:" + escapedQuery + ")(.+$)", "i"); - match = frontMatchRegEx.exec(data.val); - match && this.input.setHint(val + match[1]); - } else { - this.input.clearHint(); - } - }, - isEnabled: function isEnabled() { - return this.enabled; - }, - enable: function enable() { - this.enabled = true; - }, - disable: function disable() { - this.enabled = false; - }, - isActive: function isActive() { - return this.active; - }, - activate: function activate() { - if (this.isActive()) { - return true; - } else if (!this.isEnabled() || this.eventBus.before("active")) { - return false; - } else { - this.active = true; - this.eventBus.trigger("active"); - return true; - } - }, - deactivate: function deactivate() { - if (!this.isActive()) { - return true; - } else if (this.eventBus.before("idle")) { - return false; - } else { - this.active = false; - this.close(); - this.eventBus.trigger("idle"); - return true; - } - }, - isOpen: function isOpen() { - return this.menu.isOpen(); - }, - open: function open() { - if (!this.isOpen() && !this.eventBus.before("open")) { - this.menu.open(); - this._updateHint(); - this.eventBus.trigger("open"); - } - return this.isOpen(); - }, - close: function close() { - if (this.isOpen() && !this.eventBus.before("close")) { - this.menu.close(); - this.input.clearHint(); - this.input.resetInputValue(); - this.eventBus.trigger("close"); - } - return !this.isOpen(); - }, - setVal: function setVal(val) { - this.input.setQuery(_.toStr(val)); - }, - getVal: function getVal() { - return this.input.getQuery(); - }, - select: function select($selectable) { - var data = this.menu.getSelectableData($selectable); - if (data && !this.eventBus.before("select", data.obj, data.dataset)) { - this.input.setQuery(data.val, true); - this.eventBus.trigger("select", data.obj, data.dataset); - this.close(); - return true; - } - return false; - }, - autocomplete: function autocomplete($selectable) { - var query, data, isValid; - query = this.input.getQuery(); - data = this.menu.getSelectableData($selectable); - isValid = data && query !== data.val; - if (isValid && !this.eventBus.before("autocomplete", data.obj, data.dataset)) { - this.input.setQuery(data.val); - this.eventBus.trigger("autocomplete", data.obj, data.dataset); - return true; - } - return false; - }, - moveCursor: function moveCursor(delta) { - var query, $candidate, data, suggestion, datasetName, cancelMove, id; - query = this.input.getQuery(); - $candidate = this.menu.selectableRelativeToCursor(delta); - data = this.menu.getSelectableData($candidate); - suggestion = data ? data.obj : null; - datasetName = data ? data.dataset : null; - id = $candidate ? $candidate.attr("id") : null; - this.input.trigger("cursorchange", id); - cancelMove = this._minLengthMet() && this.menu.update(query); - if (!cancelMove && !this.eventBus.before("cursorchange", suggestion, datasetName)) { - this.menu.setCursor($candidate); - if (data) { - this.input.setInputValue(data.val); - } else { - this.input.resetInputValue(); - this._updateHint(); - } - this.eventBus.trigger("cursorchange", suggestion, datasetName); - return true; - } - return false; - }, - destroy: function destroy() { - this.input.destroy(); - this.menu.destroy(); - } - }); - return Typeahead; - function c(ctx) { - var methods = [].slice.call(arguments, 1); - return function() { - var args = [].slice.call(arguments); - _.each(methods, function(method) { - return ctx[method].apply(ctx, args); - }); - }; - } - }(); - (function() { - "use strict"; - var old, keys, methods; - old = $.fn.typeahead; - keys = { - www: "tt-www", - attrs: "tt-attrs", - typeahead: "tt-typeahead" - }; - methods = { - initialize: function initialize(o, datasets) { - var www; - datasets = _.isArray(datasets) ? datasets : [].slice.call(arguments, 1); - o = o || {}; - www = WWW(o.classNames); - return this.each(attach); - function attach() { - var $input, $wrapper, $hint, $menu, defaultHint, defaultMenu, eventBus, input, menu, status, typeahead, MenuConstructor; - _.each(datasets, function(d) { - d.highlight = !!o.highlight; - }); - $input = $(this); - $wrapper = $(www.html.wrapper); - $hint = $elOrNull(o.hint); - $menu = $elOrNull(o.menu); - defaultHint = o.hint !== false && !$hint; - defaultMenu = o.menu !== false && !$menu; - defaultHint && ($hint = buildHintFromInput($input, www)); - defaultMenu && ($menu = $(www.html.menu).css(www.css.menu)); - $hint && $hint.val(""); - $input = prepInput($input, www); - if (defaultHint || defaultMenu) { - $wrapper.css(www.css.wrapper); - $input.css(defaultHint ? www.css.input : www.css.inputWithNoHint); - $input.wrap($wrapper).parent().prepend(defaultHint ? $hint : null).append(defaultMenu ? $menu : null); - } - MenuConstructor = defaultMenu ? DefaultMenu : Menu; - eventBus = new EventBus({ - el: $input - }); - input = new Input({ - hint: $hint, - input: $input - }, www); - menu = new MenuConstructor({ - node: $menu, - datasets: datasets - }, www); - status = new Status({ - $input: $input, - menu: menu - }); - typeahead = new Typeahead({ - input: input, - menu: menu, - eventBus: eventBus, - minLength: o.minLength, - autoselect: o.autoselect - }, www); - $input.data(keys.www, www); - $input.data(keys.typeahead, typeahead); - } - }, - isEnabled: function isEnabled() { - var enabled; - ttEach(this.first(), function(t) { - enabled = t.isEnabled(); - }); - return enabled; - }, - enable: function enable() { - ttEach(this, function(t) { - t.enable(); - }); - return this; - }, - disable: function disable() { - ttEach(this, function(t) { - t.disable(); - }); - return this; - }, - isActive: function isActive() { - var active; - ttEach(this.first(), function(t) { - active = t.isActive(); - }); - return active; - }, - activate: function activate() { - ttEach(this, function(t) { - t.activate(); - }); - return this; - }, - deactivate: function deactivate() { - ttEach(this, function(t) { - t.deactivate(); - }); - return this; - }, - isOpen: function isOpen() { - var open; - ttEach(this.first(), function(t) { - open = t.isOpen(); - }); - return open; - }, - open: function open() { - ttEach(this, function(t) { - t.open(); - }); - return this; - }, - close: function close() { - ttEach(this, function(t) { - t.close(); - }); - return this; - }, - select: function select(el) { - var success = false, $el = $(el); - ttEach(this.first(), function(t) { - success = t.select($el); - }); - return success; - }, - autocomplete: function autocomplete(el) { - var success = false, $el = $(el); - ttEach(this.first(), function(t) { - success = t.autocomplete($el); - }); - return success; - }, - moveCursor: function moveCursoe(delta) { - var success = false; - ttEach(this.first(), function(t) { - success = t.moveCursor(delta); - }); - return success; - }, - val: function val(newVal) { - var query; - if (!arguments.length) { - ttEach(this.first(), function(t) { - query = t.getVal(); - }); - return query; - } else { - ttEach(this, function(t) { - t.setVal(_.toStr(newVal)); - }); - return this; - } - }, - destroy: function destroy() { - ttEach(this, function(typeahead, $input) { - revert($input); - typeahead.destroy(); - }); - return this; - } - }; - $.fn.typeahead = function(method) { - if (methods[method]) { - return methods[method].apply(this, [].slice.call(arguments, 1)); - } else { - return methods.initialize.apply(this, arguments); - } - }; - $.fn.typeahead.noConflict = function noConflict() { - $.fn.typeahead = old; - return this; - }; - function ttEach($els, fn) { - $els.each(function() { - var $input = $(this), typeahead; - (typeahead = $input.data(keys.typeahead)) && fn(typeahead, $input); - }); - } - function buildHintFromInput($input, www) { - return $input.clone().addClass(www.classes.hint).removeData().css(www.css.hint).css(getBackgroundStyles($input)).prop({ - readonly: true, - required: false - }).removeAttr("id name placeholder").removeClass("required").attr({ - spellcheck: "false", - tabindex: -1 - }); - } - function prepInput($input, www) { - $input.data(keys.attrs, { - dir: $input.attr("dir"), - autocomplete: $input.attr("autocomplete"), - spellcheck: $input.attr("spellcheck"), - style: $input.attr("style") - }); - $input.addClass(www.classes.input).attr({ - spellcheck: false - }); - try { - !$input.attr("dir") && $input.attr("dir", "auto"); - } catch (e) {} - return $input; - } - function getBackgroundStyles($el) { - return { - backgroundAttachment: $el.css("background-attachment"), - backgroundClip: $el.css("background-clip"), - backgroundColor: $el.css("background-color"), - backgroundImage: $el.css("background-image"), - backgroundOrigin: $el.css("background-origin"), - backgroundPosition: $el.css("background-position"), - backgroundRepeat: $el.css("background-repeat"), - backgroundSize: $el.css("background-size") - }; - } - function revert($input) { - var www, $wrapper; - www = $input.data(keys.www); - $wrapper = $input.parent().filter(www.selectors.wrapper); - _.each($input.data(keys.attrs), function(val, key) { - _.isUndefined(val) ? $input.removeAttr(key) : $input.attr(key, val); - }); - $input.removeData(keys.typeahead).removeData(keys.www).removeData(keys.attr).removeClass(www.classes.input); - if ($wrapper.length) { - $input.detach().insertAfter($wrapper); - $wrapper.remove(); - } - } - function $elOrNull(obj) { - var isValid, $el; - isValid = _.isJQuery(obj) || _.isElement(obj); - $el = isValid ? $(obj).first() : []; - return $el.length ? $el : null; - } - })(); -}); \ No newline at end of file diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/search.json b/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/search.json deleted file mode 100644 index 2b66ccdb..00000000 --- a/docs/docsets/XCoordinator.docset/Contents/Resources/Documents/search.json +++ /dev/null @@ -1 +0,0 @@ -{"Typealiases.html#/s:12XCoordinator24AnyNavigationCoordinatora":{"name":"AnyNavigationCoordinator","abstract":"

A type-erased Coordinator (AnyCoordinator) with a UINavigationController as rootViewController.

"},"Typealiases.html#/s:12XCoordinator20AnyTabBarCoordinatora":{"name":"AnyTabBarCoordinator","abstract":"

A type-erased Coordinator (AnyCoordinator) with a UITabBarController as rootViewController.

"},"Typealiases.html#/s:12XCoordinator18AnyViewCoordinatora":{"name":"AnyViewCoordinator","abstract":"

A type-erased Coordinator (AnyCoordinator) with a UIViewController as rootViewController.

"},"Typealiases.html#/s:12XCoordinator26BasicNavigationCoordinatora":{"name":"BasicNavigationCoordinator","abstract":"

A BasicCoordinator with a UINavigationController as its rootViewController.

"},"Typealiases.html#/s:12XCoordinator20BasicViewCoordinatora":{"name":"BasicViewCoordinator","abstract":"

A BasicCoordinator with a UIViewController as its rootViewController.

"},"Typealiases.html#/s:12XCoordinator22BasicTabBarCoordinatora":{"name":"BasicTabBarCoordinator","abstract":"

A BasicCoordinator with a UITabBarController as its rootViewController.

"},"Typealiases.html#/s:12XCoordinator19PresentationHandlera":{"name":"PresentationHandler","abstract":"

The completion handler for transitions.

"},"Typealiases.html#/s:12XCoordinator26ContextPresentationHandlera":{"name":"ContextPresentationHandler","abstract":"

The completion handler for transitions, which also provides the context information about the transition.

"},"Typealiases.html#/s:12XCoordinator20NavigationTransitiona":{"name":"NavigationTransition","abstract":"

NavigationTransition offers transitions that can be used"},"Typealiases.html#/s:12XCoordinator14PageTransitiona":{"name":"PageTransition","abstract":"

PageTransition offers transitions that can be used"},"Typealiases.html#/s:12XCoordinator15SplitTransitiona":{"name":"SplitTransition","abstract":"

SplitTransition offers different transitions common to a UISplitViewController rootViewController.

"},"Typealiases.html#/s:12XCoordinator16TabBarTransitiona":{"name":"TabBarTransition","abstract":"

TabBarTransition offers transitions that can be used"},"Typealiases.html#/s:12XCoordinator9AnyRoutera":{"name":"AnyRouter","abstract":"

Please use StrongRouter, WeakRouter or UnownedRouter instead.

"},"Typealiases.html#/s:12XCoordinator13UnownedRoutera":{"name":"UnownedRouter","abstract":"

An UnownedRouter is an unowned version of a router object to be used in view controllers or view models.

"},"Typealiases.html#/s:12XCoordinator14ViewTransitiona":{"name":"ViewTransition","abstract":"

ViewTransition offers transitions common to any UIViewController rootViewController.

"},"Typealiases.html#/s:12XCoordinator10WeakRoutera":{"name":"WeakRouter","abstract":"

A WeakRouter is a weak version of a router object to be used in view controllers or view models.

"},"Structs/WeakErased.html#/wrappedValue":{"name":"wrappedValue","abstract":"

The type-erased or otherwise mapped version of the value being held weakly.

","parent_name":"WeakErased"},"Structs/WeakErased.html#/s:12XCoordinator10WeakErasedV12wrappedValuexSgvp":{"name":"wrappedValue","abstract":"

The type-erased or otherwise mapped version of the value being held weakly.

","parent_name":"WeakErased"},"Structs/WeakErased.html#/s:12XCoordinator11PresentableP14viewControllerSo06UIViewD0CSgvp":{"name":"viewController","parent_name":"WeakErased"},"Structs/WeakErased.html#/s:12XCoordinator11PresentableP24childTransitionCompletedyyF":{"name":"childTransitionCompleted()","parent_name":"WeakErased"},"Structs/WeakErased.html#/s:12XCoordinator11PresentableP14registerParentyyAaB_XlF":{"name":"registerParent(_:)","parent_name":"WeakErased"},"Structs/WeakErased.html#/s:12XCoordinator11PresentableP9presented4fromyAaB_pSg_tF":{"name":"presented(from:)","parent_name":"WeakErased"},"Structs/WeakErased.html#/s:12XCoordinator11PresentableP7setRoot3forySo8UIWindowC_tF":{"name":"setRoot(for:)","parent_name":"WeakErased"},"Structs/WeakErased.html#/s:12XCoordinator6RouterP14contextTrigger_4with10completiony9RouteTypeQz_AA17TransitionOptionsVyAA0I7Context_pcSgtF":{"name":"contextTrigger(_:with:completion:)","parent_name":"WeakErased"},"Structs/WeakErased.html#/s:12XCoordinator10WeakErasedV_5eraseACyxGqd___xqd__ctcRld__Clufc":{"name":"init(_:erase:)","abstract":"

Create a WeakErased wrapper using an initial value and a closure to create the type-erased object.","parent_name":"WeakErased"},"Structs/WeakErased.html#/s:12XCoordinator10WeakErasedV3set_5eraseyqd___xqd__ctRld__ClF":{"name":"set(_:erase:)","abstract":"

Set a new value by providing a non-type-erased value and a closure to create the type-erased object.

","parent_name":"WeakErased"},"Structs/UnownedErased.html#/wrappedValue":{"name":"wrappedValue","abstract":"

The type-erased or otherwise mapped version of the value being held unowned.

","parent_name":"UnownedErased"},"Structs/UnownedErased.html#/s:12XCoordinator13UnownedErasedV12wrappedValuexvp":{"name":"wrappedValue","abstract":"

The type-erased or otherwise mapped version of the value being held unowned.

","parent_name":"UnownedErased"},"Structs/UnownedErased.html#/s:12XCoordinator11PresentableP14viewControllerSo06UIViewD0CSgvp":{"name":"viewController","parent_name":"UnownedErased"},"Structs/UnownedErased.html#/s:12XCoordinator11PresentableP24childTransitionCompletedyyF":{"name":"childTransitionCompleted()","parent_name":"UnownedErased"},"Structs/UnownedErased.html#/s:12XCoordinator11PresentableP14registerParentyyAaB_XlF":{"name":"registerParent(_:)","parent_name":"UnownedErased"},"Structs/UnownedErased.html#/s:12XCoordinator11PresentableP9presented4fromyAaB_pSg_tF":{"name":"presented(from:)","parent_name":"UnownedErased"},"Structs/UnownedErased.html#/s:12XCoordinator11PresentableP7setRoot3forySo8UIWindowC_tF":{"name":"setRoot(for:)","parent_name":"UnownedErased"},"Structs/UnownedErased.html#/s:12XCoordinator6RouterP14contextTrigger_4with10completiony9RouteTypeQz_AA17TransitionOptionsVyAA0I7Context_pcSgtF":{"name":"contextTrigger(_:with:completion:)","parent_name":"UnownedErased"},"Structs/UnownedErased.html#/s:12XCoordinator13UnownedErasedV_5eraseACyxGqd___xqd__ctcRld__Clufc":{"name":"init(_:erase:)","abstract":"

Create an UnownedErased wrapper using an initial value and a closure to create the type-erased object.","parent_name":"UnownedErased"},"Structs/UnownedErased.html#/s:12XCoordinator13UnownedErasedV3set_5eraseyqd___xqd__ctRld__ClF":{"name":"set(_:erase:)","abstract":"

Set a new value by providing a non-type-erased value and a closure to create the type-erased object.

","parent_name":"UnownedErased"},"Structs/TransitionOptions.html#/s:12XCoordinator17TransitionOptionsV8animatedSbvp":{"name":"animated","abstract":"

Specifies whether or not the transition should be animated.

","parent_name":"TransitionOptions"},"Structs/TransitionOptions.html#/s:12XCoordinator17TransitionOptionsV8animatedACSb_tcfc":{"name":"init(animated:)","abstract":"

Creates transition options on the basis of whether or not it should be animated.

","parent_name":"TransitionOptions"},"Structs/Transition.html#/s:12XCoordinator10TransitionV14PerformClosurea":{"name":"PerformClosure","abstract":"

Perform is the type of closure used to perform the transition.

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV12presentablesSayAA11Presentable_pGvp":{"name":"presentables","abstract":"

The presentables this transition is putting into the view hierarchy. This is especially useful for","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV9animationAA0B9Animation_pSgvp":{"name":"animation","abstract":"

The transition animation this transition is using, i.e. the presentation or dismissal animation","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV12presentables14animationInUse7performACyxGSayAA11Presentable_pG_AA0B9Animation_pSgyx_AA0B7OptionsVyycSgtctcfc":{"name":"init(presentables:animationInUse:perform:)","abstract":"

Create your custom transitions with this initializer.

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV7perform2on4with10completionyx_AA0B7OptionsVyycSgtF":{"name":"perform(on:with:completion:)","abstract":"

Performs a transition on the given viewController.

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionVAASo22UINavigationControllerCRbzrlE4push_9animationACyxGAA11Presentable_p_AA9AnimationCSgtFZ":{"name":"push(_:animation:)","abstract":"

Pushes a presentable on the rootViewController’s navigation stack.

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionVAASo22UINavigationControllerCRbzrlE3pop9animationACyxGAA9AnimationCSg_tFZ":{"name":"pop(animation:)","abstract":"

Pops the topViewController from the rootViewController’s navigation stack.

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionVAASo22UINavigationControllerCRbzrlE3pop2to9animationACyxGAA11Presentable_p_AA9AnimationCSgtFZ":{"name":"pop(to:animation:)","abstract":"

Pops viewControllers from the rootViewController’s navigation stack until the specified","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionVAASo22UINavigationControllerCRbzrlE9popToRoot9animationACyxGAA9AnimationCSg_tFZ":{"name":"popToRoot(animation:)","abstract":"

Pops viewControllers from the rootViewController’s navigation stack until only one viewController","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionVAASo22UINavigationControllerCRbzrlE3set_9animationACyxGSayAA11Presentable_pG_AA9AnimationCSgtFZ":{"name":"set(_:animation:)","abstract":"

Replaces the navigation stack of the rootViewController with the specified presentables.

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionVAASo20UIPageViewControllerCRbzrlE3set__9directionACyxGAA11Presentable_p_AaI_pSgSo0cdE19NavigationDirectionVtFZ":{"name":"set(_:_:direction:)","abstract":"

Sets the current page(s) of the rootViewController. Make sure to set","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionVAASo18UITabBarControllerCRbzrlE3set_9animationACyxGSayAA11Presentable_pG_AA9AnimationCSgtFZ":{"name":"set(_:animation:)","abstract":"

Transition to set the tabs of the rootViewController with an optional custom animation.

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionVAASo18UITabBarControllerCRbzrlE6select_9animationACyxGAA11Presentable_p_AA9AnimationCSgtFZ":{"name":"select(_:animation:)","abstract":"

Transition to select a tab with an optional custom animation.

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionVAASo18UITabBarControllerCRbzrlE6select5index9animationACyxGSi_AA9AnimationCSgtFZ":{"name":"select(index:animation:)","abstract":"

Transition to select a tab with an optional custom animation.

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV4showyACyxGAA11Presentable_pFZ":{"name":"show(_:)","abstract":"

Shows a viewController by calling show on the rootViewController.

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV10showDetailyACyxGAA11Presentable_pFZ":{"name":"showDetail(_:)","abstract":"

Shows a detail viewController by calling showDetail on the rootViewController.

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV13presentOnRoot_9animationACyxGAA11Presentable_p_AA9AnimationCSgtFZ":{"name":"presentOnRoot(_:animation:)","abstract":"

Transition to present the given presentable on the rootViewController.

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV7present_9animationACyxGAA11Presentable_p_AA9AnimationCSgtFZ":{"name":"present(_:animation:)","abstract":"

Transition to present the given presentable. It uses the rootViewController’s presentedViewController,","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV5embed_2inACyxGAA11Presentable_p_AA9Container_ptFZ":{"name":"embed(_:in:)","abstract":"

Transition to embed the given presentable in a specific container (i.e. a view or viewController).

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV13dismissToRoot9animationACyxGAA9AnimationCSg_tFZ":{"name":"dismissToRoot(animation:)","abstract":"

Transition to call dismiss on the rootViewController. Also take a look at the dismiss transition,","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV7dismiss9animationACyxGAA9AnimationCSg_tFZ":{"name":"dismiss(animation:)","abstract":"

Transition to call dismiss on the rootViewController’s presentedViewController, if present.","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV4noneACyxGyFZ":{"name":"none()","abstract":"

No transition at all. May be useful for testing or debugging purposes, or to ignore specific","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV8multipleyACyxGqd__SlRd__AE7ElementRtd__lFZ":{"name":"multiple(_:)","abstract":"

With this transition you can chain multiple transitions of the same type together.

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV5route_2onACyxG9RouteTypeQyd___qd__tAA11CoordinatorRd__lFZ":{"name":"route(_:on:)","abstract":"

Use this transition to trigger a route on another coordinator. TransitionOptions and","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV7trigger_2onACyxG9RouteTypeQyd___qd__tAA6RouterRd__lFZ":{"name":"trigger(_:on:)","abstract":"

Use this transition to trigger a route on another router. TransitionOptions and","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV7perform_2onACyxGqd___18RootViewControllerQyd__tAA0B8ProtocolRd__lFZ":{"name":"perform(_:on:)","abstract":"

Performs a transition on a different viewController than the coordinator’s rootViewController.

","parent_name":"Transition"},"Structs/Transition.html":{"name":"Transition","abstract":"

This struct represents the common implementation of the TransitionProtocol."},"Structs/TransitionOptions.html":{"name":"TransitionOptions","abstract":"

TransitionOptions specifies transition customization points defined at the point of triggering a transition.

"},"Structs/UnownedErased.html":{"name":"UnownedErased","abstract":"

UnownedErased is a property wrapper to hold objects with an unowned reference when using type-erasure.

"},"Structs/WeakErased.html":{"name":"WeakErased","abstract":"

WeakErased is a property wrapper to hold objects with a weak reference when using type-erasure.

"},"Protocols/TransitionProtocol.html#/s:12XCoordinator18TransitionProtocolP18RootViewControllerQa":{"name":"RootViewController","abstract":"

The type of the rootViewController that can execute the transition.

","parent_name":"TransitionProtocol"},"Protocols/TransitionProtocol.html#/s:12XCoordinator18TransitionProtocolP7perform2on4with10completiony18RootViewControllerQz_AA0B7OptionsVyycSgtF":{"name":"perform(on:with:completion:)","abstract":"

Performs a transition on the given viewController.

","parent_name":"TransitionProtocol"},"Protocols/TransitionProtocol.html#/s:12XCoordinator18TransitionProtocolP8multipleyxSayxGFZ":{"name":"multiple(_:)","abstract":"

Creates a compound transition by chaining multiple transitions together.

","parent_name":"TransitionProtocol"},"Protocols/TransitionPerformer.html#/s:12XCoordinator19TransitionPerformerP0B4TypeQa":{"name":"TransitionType","abstract":"

The type of transitions that can be executed on the rootViewController.

","parent_name":"TransitionPerformer"},"Protocols/TransitionPerformer.html#/s:12XCoordinator19TransitionPerformerP18rootViewController0B4Type_04RooteF0QZvp":{"name":"rootViewController","abstract":"

The rootViewController on which transitions are performed.

","parent_name":"TransitionPerformer"},"Protocols/TransitionPerformer.html#/s:12XCoordinator19TransitionPerformerP07performB0_4with10completiony0B4TypeQz_AA0B7OptionsVyycSgtF":{"name":"performTransition(_:with:completion:)","abstract":"

Perform a transition.

","parent_name":"TransitionPerformer"},"Protocols/PercentDrivenInteractionController.html#/s:12XCoordinator34PercentDrivenInteractionControllerP6updateyy12CoreGraphics7CGFloatVF":{"name":"update(_:)","abstract":"

Updates the animation to be at the specified progress.

","parent_name":"PercentDrivenInteractionController"},"Protocols/PercentDrivenInteractionController.html#/s:12XCoordinator34PercentDrivenInteractionControllerP6cancelyyF":{"name":"cancel()","abstract":"

Cancels the animation, e.g. by cleaning up and reversing any progress made.

","parent_name":"PercentDrivenInteractionController"},"Protocols/PercentDrivenInteractionController.html#/s:12XCoordinator34PercentDrivenInteractionControllerP6finishyyF":{"name":"finish()","abstract":"

Finishes the animation by completing it from the current progress onwards.

","parent_name":"PercentDrivenInteractionController"},"Protocols/TransitionAnimation.html#/s:12XCoordinator19TransitionAnimationP21interactionControllerAA024PercentDrivenInteractionE0_pSgvp":{"name":"interactionController","abstract":"

The interaction controller of an animation.","parent_name":"TransitionAnimation"},"Protocols/TransitionAnimation.html#/s:12XCoordinator19TransitionAnimationP5startyyF":{"name":"start()","abstract":"

Starts the animation by possibly creating a new interaction controller.

","parent_name":"TransitionAnimation"},"Protocols/TransitionAnimation.html#/s:12XCoordinator19TransitionAnimationP7cleanupyyF":{"name":"cleanup()","abstract":"

Cleans up a TransitionAnimation after an animation has been completed, e.g. by deleting an interaction controller.

","parent_name":"TransitionAnimation"},"Protocols/Router.html#/s:12XCoordinator6RouterP9RouteTypeQa":{"name":"RouteType","abstract":"

RouteType defines which routes can be triggered in a certain Router implementation.

","parent_name":"Router"},"Protocols/Router.html#/s:12XCoordinator6RouterP14contextTrigger_4with10completiony9RouteTypeQz_AA17TransitionOptionsVyAA0I7Context_pcSgtF":{"name":"contextTrigger(_:with:completion:)","abstract":"

Triggers routes and returns context in completion-handler.

","parent_name":"Router"},"Protocols/Router.html#/s:12XCoordinator6RouterPAAE7trigger_4withy9RouteTypeQz_AA17TransitionOptionsVtF":{"name":"trigger(_:with:)","abstract":"

Triggers the specified route without the need of specifying a completion handler.

","parent_name":"Router"},"Protocols/Router.html#/s:12XCoordinator6RouterPAAE7trigger_10completiony9RouteTypeQz_yycSgtF":{"name":"trigger(_:completion:)","abstract":"

Triggers the specified route with default transition options enabling the animation of the transition.

","parent_name":"Router"},"Protocols/Router.html#/s:12XCoordinator6RouterPAAE7trigger_4with10completiony9RouteTypeQz_AA17TransitionOptionsVyycSgtF":{"name":"trigger(_:with:completion:)","abstract":"

Triggers the specified route by performing a transition.

","parent_name":"Router"},"Protocols/Router.html#/s:12XCoordinator6RouterPAAE06strongB0AA06StrongB0Cy9RouteTypeQzGvp":{"name":"strongRouter","abstract":"

Creates a StrongRouter object from the given router to abstract from concrete implementations","parent_name":"Router"},"Protocols/Router.html#/s:12XCoordinator6RouterPAAE6router3forAA06StrongB0Cyqd__GSgqd___tAA5RouteRd__lF":{"name":"router(for:)","abstract":"

Returns a router for the specified route, if possible.

","parent_name":"Router"},"Protocols/Presentable.html#/s:12XCoordinator11PresentableP14viewControllerSo06UIViewD0CSgvp":{"name":"viewController","abstract":"

The viewController of the Presentable.

","parent_name":"Presentable"},"Protocols/Presentable.html#/s:12XCoordinator11PresentableP6router3forAA12StrongRouterCyqd__GSgqd___tAA5RouteRd__lF":{"name":"router(for:)","abstract":"

This method can be used to retrieve whether the presentable can trigger a specific route","parent_name":"Presentable"},"Protocols/Presentable.html#/s:12XCoordinator11PresentableP9presented4fromyAaB_pSg_tF":{"name":"presented(from:)","abstract":"

This method is called whenever a Presentable is shown to the user.","parent_name":"Presentable"},"Protocols/Presentable.html#/s:12XCoordinator11PresentableP14registerParentyyAaB_XlF":{"name":"registerParent(_:)","abstract":"

This method is used to register a parent coordinator to a child coordinator.

","parent_name":"Presentable"},"Protocols/Presentable.html#/s:12XCoordinator11PresentableP24childTransitionCompletedyyF":{"name":"childTransitionCompleted()","abstract":"

This method gets called when the transition of a child coordinator is being reported to its parent.

","parent_name":"Presentable"},"Protocols/Presentable.html#/s:12XCoordinator11PresentableP7setRoot3forySo8UIWindowC_tF":{"name":"setRoot(for:)","abstract":"

Sets the presentable as the root of the window.

","parent_name":"Presentable"},"Protocols/TransitionContext.html#/s:12XCoordinator17TransitionContextP12presentablesSayAA11Presentable_pGvp":{"name":"presentables","abstract":"

The presentables being shown to the user by the transition.

","parent_name":"TransitionContext"},"Protocols/TransitionContext.html#/s:12XCoordinator17TransitionContextP9animationAA0B9Animation_pSgvp":{"name":"animation","abstract":"

The transition animation directly used in the transition, if applicable.

","parent_name":"TransitionContext"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorP17prepareTransition3for0D4TypeQz05RouteF0Qz_tF":{"name":"prepareTransition(for:)","abstract":"

This method prepares transitions for routes.","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorP8addChildyyAA11Presentable_pF":{"name":"addChild(_:)","abstract":"

This method adds a child to a coordinator’s children.

","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorP11removeChildyyAA11Presentable_pF":{"name":"removeChild(_:)","abstract":"

This method removes a child to a coordinator’s children.

","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorP22removeChildrenIfNeededyyF":{"name":"removeChildrenIfNeeded()","abstract":"

This method removes all children that are no longer in the view hierarchy.

","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAAE18RootViewControllera":{"name":"RootViewController","abstract":"

Shortcut for Coordinator.TransitionType.RootViewController

","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAAE14viewControllerSo06UIViewD0CSgvp":{"name":"viewController","abstract":"

A Coordinator uses its rootViewController as viewController.

","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAARlzCrlE10weakRouterAA10WeakErasedVyAA06StrongD0Cy9RouteTypeQzGGvp":{"name":"weakRouter","abstract":"

Creates a WeakRouter object from the given router to abstract from concrete implementations","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAARlzCrlE13unownedRouterAA13UnownedErasedVyAA06StrongD0Cy9RouteTypeQzGGvp":{"name":"unownedRouter","abstract":"

Creates an UnownedRouter object from the given router to abstract from concrete implementations","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAARlzCrlE03anyB0AA03AnyB0Cy9RouteTypeQz010TransitionF0QzGvp":{"name":"anyCoordinator","abstract":"

Creates an AnyCoordinator based on the current coordinator.

","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11PresentableP9presented4fromyAaB_pSg_tF":{"name":"presented(from:)","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11PresentableP24childTransitionCompletedyyF":{"name":"childTransitionCompleted()","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAARlzCrlE14contextTrigger_4with10completiony9RouteTypeQz_AA17TransitionOptionsVyAA0I7Context_pcSgtF":{"name":"contextTrigger(_:with:completion:)","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAARlzCrlE5chain6routes14TransitionTypeQzSay05RouteF0QzG_tF":{"name":"chain(routes:)","abstract":"

With chain(routes:) different routes can be chained together to form a combined transition.

","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator19TransitionPerformerP07performB0_4with10completiony0B4TypeQz_AA0B7OptionsVyycSgtF":{"name":"performTransition(_:with:completion:)","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAARlzCrlE8deepLinkyAA10TransitionVyqd__G9RouteTypeQz_qd_0_tSo16UIViewControllerCRbd__STRd_0_AG0eG0RtzAA0F0_p7ElementRtd_0_r0_lF":{"name":"deepLink(_:_:)","abstract":"

Deep-Linking can be used to chain routes of different types together.

","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAARlzCrlE8deepLinkyAA10TransitionVyqd__G9RouteTypeQz_AA0F0_pdtSo16UIViewControllerCRbd__AG0eG0RtzlF":{"name":"deepLink(_:_:)","abstract":"

Deep-Linking can be used to chain routes of different types together.

","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAARlzCrlE12registerPeek3for5routeAA10TransitionVyqd__GAA9Container_p_9RouteTypeQztSo16UIViewControllerCRbd__AI0gJ0RtzlF":{"name":"registerPeek(for:route:)","abstract":"

Use this transition to register 3D Touch Peek and Pop functionality.

","parent_name":"Coordinator"},"Protocols/Container.html#/s:12XCoordinator9ContainerP4viewSo6UIViewCSgvp":{"name":"view","abstract":"

The view of the Container.

","parent_name":"Container"},"Protocols/Container.html#/s:12XCoordinator9ContainerP14viewControllerSo06UIViewD0CSgvp":{"name":"viewController","abstract":"

The viewController of the Container.

","parent_name":"Container"},"Protocols/Container.html":{"name":"Container","abstract":"

Container abstracts away from the difference of UIView and UIViewController

"},"Protocols/Coordinator.html":{"name":"Coordinator","abstract":"

Coordinator is the protocol every coordinator conforms to.

"},"Protocols/TransitionContext.html":{"name":"TransitionContext","abstract":"

TransitionContext provides context information about transitions.

"},"Protocols/Presentable.html":{"name":"Presentable","abstract":"

Presentable represents all objects that can be presented (i.e. shown) to the user.

"},"Protocols.html#/s:12XCoordinator5RouteP":{"name":"Route","abstract":"

This is the protocol your route types need to conform to.

"},"Protocols/Router.html":{"name":"Router","abstract":"

The Router protocol is used to abstract the transition-type specific characteristics of a Coordinator.

"},"Protocols/TransitionAnimation.html":{"name":"TransitionAnimation","abstract":"

TransitionAnimation aims to provide a common protocol for any type of transition animation used in an Animation object.

"},"Protocols/PercentDrivenInteractionController.html":{"name":"PercentDrivenInteractionController","abstract":"

PercentDrivenInteractionController is used for interaction controller types that can updated based on a percentage of completion."},"Protocols/TransitionPerformer.html":{"name":"TransitionPerformer","abstract":"

The TransitionPerformer protocol is used to abstract the route-type specific characteristics of a Coordinator."},"Protocols/TransitionProtocol.html":{"name":"TransitionProtocol","abstract":"

TransitionProtocol is used to abstract any concrete transition implementation.

"},"Extensions/UIView.html#/s:12XCoordinator9ContainerP14viewControllerSo06UIViewD0CSgvp":{"name":"viewController","parent_name":"UIView"},"Extensions/UIView.html#/s:12XCoordinator9ContainerP4viewSo6UIViewCSgvp":{"name":"view","parent_name":"UIView"},"Extensions/UIViewController.html#/s:12XCoordinator9ContainerP14viewControllerSo06UIViewD0CSgvp":{"name":"viewController","parent_name":"UIViewController"},"Extensions/UIViewController.html":{"name":"UIViewController"},"Extensions/UIView.html":{"name":"UIView"},"Classes/ViewCoordinator.html#/s:12XCoordinator15ViewCoordinatorC04rootB10Controller12initialRouteACyxGSo06UIViewE0C_xSgtcfc":{"name":"init(rootViewController:initialRoute:)","parent_name":"ViewCoordinator"},"Classes/TabBarCoordinator.html#/s:12XCoordinator17TabBarCoordinatorC8delegateSo05UITabC18ControllerDelegate_pSgvp":{"name":"delegate","abstract":"

Use this delegate to get informed about tabbarController-related notifications and delegate methods","parent_name":"TabBarCoordinator"},"Classes/TabBarCoordinator.html#/s:12XCoordinator17TabBarCoordinatorC18rootViewController12initialRouteACyxGSo05UITabcG0C_xSgtcfc":{"name":"init(rootViewController:initialRoute:)","parent_name":"TabBarCoordinator"},"Classes/TabBarCoordinator.html#/s:12XCoordinator17TabBarCoordinatorC18rootViewController4tabsACyxGSo05UITabcG0C_SayAA11Presentable_pGtcfc":{"name":"init(rootViewController:tabs:)","abstract":"

Creates a TabBarCoordinator with a specified set of tabs.

","parent_name":"TabBarCoordinator"},"Classes/TabBarCoordinator.html#/s:12XCoordinator17TabBarCoordinatorC18rootViewController4tabs6selectACyxGSo05UITabcG0C_SayAA11Presentable_pGAaJ_ptcfc":{"name":"init(rootViewController:tabs:select:)","abstract":"

Creates a TabBarCoordinator with a specified set of tabs and selects a specific presentable.

","parent_name":"TabBarCoordinator"},"Classes/TabBarCoordinator.html#/s:12XCoordinator17TabBarCoordinatorC18rootViewController4tabs6selectACyxGSo05UITabcG0C_SayAA11Presentable_pGSitcfc":{"name":"init(rootViewController:tabs:select:)","abstract":"

Creates a TabBarCoordinator with a specified set of tabs and selects a presentable at a given index.

","parent_name":"TabBarCoordinator"},"Classes/TabBarAnimationDelegate.html#/c:@CM@XCoordinator@objc(cs)TabBarAnimationDelegate(im)tabBarController:interactionControllerForAnimationController:":{"name":"tabBarController(_:interactionControllerFor:)","abstract":"

See UITabBarControllerDelegate","parent_name":"TabBarAnimationDelegate"},"Classes/TabBarAnimationDelegate.html#/c:@CM@XCoordinator@objc(cs)TabBarAnimationDelegate(im)tabBarController:animationControllerForTransitionFromViewController:toViewController:":{"name":"tabBarController(_:animationControllerForTransitionFrom:to:)","abstract":"

See UITabBarControllerDelegate","parent_name":"TabBarAnimationDelegate"},"Classes/TabBarAnimationDelegate.html#/c:@CM@XCoordinator@objc(cs)TabBarAnimationDelegate(im)tabBarController:didSelectViewController:":{"name":"tabBarController(_:didSelect:)","abstract":"

See UITabBarControllerDelegate","parent_name":"TabBarAnimationDelegate"},"Classes/TabBarAnimationDelegate.html#/c:@CM@XCoordinator@objc(cs)TabBarAnimationDelegate(im)tabBarController:shouldSelectViewController:":{"name":"tabBarController(_:shouldSelect:)","abstract":"

See UITabBarControllerDelegate","parent_name":"TabBarAnimationDelegate"},"Classes/TabBarAnimationDelegate.html#/c:@CM@XCoordinator@objc(cs)TabBarAnimationDelegate(im)tabBarController:willBeginCustomizingViewControllers:":{"name":"tabBarController(_:willBeginCustomizing:)","abstract":"

See UITabBarControllerDelegate","parent_name":"TabBarAnimationDelegate"},"Classes/TabBarAnimationDelegate.html#/c:@CM@XCoordinator@objc(cs)TabBarAnimationDelegate(im)tabBarController:didEndCustomizingViewControllers:changed:":{"name":"tabBarController(_:didEndCustomizing:changed:)","abstract":"

See UITabBarControllerDelegate","parent_name":"TabBarAnimationDelegate"},"Classes/TabBarAnimationDelegate.html#/c:@CM@XCoordinator@objc(cs)TabBarAnimationDelegate(im)tabBarController:willEndCustomizingViewControllers:changed:":{"name":"tabBarController(_:willEndCustomizing:changed:)","abstract":"

See UITabBarControllerDelegate","parent_name":"TabBarAnimationDelegate"},"Classes/StrongRouter.html#/s:12XCoordinator12StrongRouterCyACyxGqd__c9RouteTypeQyd__RszAA0C0Rd__lufc":{"name":"init(_:)","abstract":"

Creates a StrongRouter object from a given router.

","parent_name":"StrongRouter"},"Classes/StrongRouter.html#/s:12XCoordinator12StrongRouterC14contextTrigger_4with10completionyx_AA17TransitionOptionsVyAA0H7Context_pcSgtF":{"name":"contextTrigger(_:with:completion:)","abstract":"

Triggers routes and provides the transition context in the completion-handler.

","parent_name":"StrongRouter"},"Classes/StrongRouter.html#/s:12XCoordinator12StrongRouterC7trigger_4with10completionyx_AA17TransitionOptionsVyycSgtF":{"name":"trigger(_:with:completion:)","abstract":"

Triggers the specified route by performing a transition.

","parent_name":"StrongRouter"},"Classes/StrongRouter.html#/s:12XCoordinator12StrongRouterC9presented4fromyAA11Presentable_pSg_tF":{"name":"presented(from:)","abstract":"

This method is called whenever a Presentable is shown to the user.","parent_name":"StrongRouter"},"Classes/StrongRouter.html#/s:12XCoordinator12StrongRouterC14viewControllerSo06UIViewE0CSgvp":{"name":"viewController","abstract":"

The viewController of the Presentable.

","parent_name":"StrongRouter"},"Classes/StrongRouter.html#/s:12XCoordinator11PresentableP14registerParentyyAaB_XlF":{"name":"registerParent(_:)","parent_name":"StrongRouter"},"Classes/StrongRouter.html#/s:12XCoordinator11PresentableP24childTransitionCompletedyyF":{"name":"childTransitionCompleted()","parent_name":"StrongRouter"},"Classes/StaticTransitionAnimation.html#/s:12XCoordinator19TransitionAnimationP21interactionControllerAA024PercentDrivenInteractionE0_pSgvp":{"name":"interactionController","parent_name":"StaticTransitionAnimation"},"Classes/StaticTransitionAnimation.html#/s:12XCoordinator25StaticTransitionAnimationC8duration07performD0ACSd_ySo36UIViewControllerContextTransitioning_pctcfc":{"name":"init(duration:performAnimation:)","abstract":"

Creates a StaticTransitionAnimation to be used as presentation or dismissal transition animation in","parent_name":"StaticTransitionAnimation"},"Classes/StaticTransitionAnimation.html#/c:@M@XCoordinator@objc(cs)StaticTransitionAnimation(im)transitionDuration:":{"name":"transitionDuration(using:)","abstract":"

See UIViewControllerAnimatedTransitioning","parent_name":"StaticTransitionAnimation"},"Classes/StaticTransitionAnimation.html#/c:@M@XCoordinator@objc(cs)StaticTransitionAnimation(im)animateTransition:":{"name":"animateTransition(using:)","abstract":"

See UIViewControllerAnimatedTransitioning","parent_name":"StaticTransitionAnimation"},"Classes/StaticTransitionAnimation.html#/s:12XCoordinator19TransitionAnimationP5startyyF":{"name":"start()","parent_name":"StaticTransitionAnimation"},"Classes/StaticTransitionAnimation.html#/s:12XCoordinator19TransitionAnimationP7cleanupyyF":{"name":"cleanup()","parent_name":"StaticTransitionAnimation"},"Classes/SplitCoordinator.html#/s:12XCoordinator16SplitCoordinatorC18rootViewController12initialRouteACyxGSo07UISpliteF0C_xSgtcfc":{"name":"init(rootViewController:initialRoute:)","parent_name":"SplitCoordinator"},"Classes/SplitCoordinator.html#/s:12XCoordinator16SplitCoordinatorC18rootViewController6master6detailACyxGSo07UISpliteF0C_AA11Presentable_pAaJ_pSgtcfc":{"name":"init(rootViewController:master:detail:)","abstract":"

Creates a SplitCoordinator and sets the specified presentables as the rootViewController’s","parent_name":"SplitCoordinator"},"Classes/RedirectionRouter.html#/s:12XCoordinator17RedirectionRouterC6parentAA13UnownedErasedVyAA06StrongC0CyxGGvp":{"name":"parent","abstract":"

A type-erased Router object of the parent router.

","parent_name":"RedirectionRouter"},"Classes/RedirectionRouter.html#/s:12XCoordinator17RedirectionRouterC14viewControllerSo06UIViewE0CSgvp":{"name":"viewController","abstract":"

The viewController used in transitions, e.g. when pushing, presenting","parent_name":"RedirectionRouter"},"Classes/RedirectionRouter.html#/s:12XCoordinator17RedirectionRouterC14viewController6parent3mapACyxq_GSo06UIViewE0C_AA13UnownedErasedVyAA06StrongC0CyxGGxq_cSgtcfc":{"name":"init(viewController:parent:map:)","abstract":"

Creates a RedirectionRouter with a certain viewController, a parent router","parent_name":"RedirectionRouter"},"Classes/RedirectionRouter.html#/s:12XCoordinator6RouterP14contextTrigger_4with10completiony9RouteTypeQz_AA17TransitionOptionsVyAA0I7Context_pcSgtF":{"name":"contextTrigger(_:with:completion:)","parent_name":"RedirectionRouter"},"Classes/RedirectionRouter.html#/s:12XCoordinator17RedirectionRouterC16mapToParentRouteyxq_F":{"name":"mapToParentRoute(_:)","abstract":"

Map RouteType to ParentRoute.

","parent_name":"RedirectionRouter"},"Classes/PageCoordinatorDataSource.html#/s:12XCoordinator25PageCoordinatorDataSourceC5pagesSaySo16UIViewControllerCGvp":{"name":"pages","abstract":"

The pages of the UIPageViewController in sequential order.

","parent_name":"PageCoordinatorDataSource"},"Classes/PageCoordinatorDataSource.html#/s:12XCoordinator25PageCoordinatorDataSourceC4loopSbvp":{"name":"loop","abstract":"

Whether or not the pages of the UIPageViewController should be in a loop,","parent_name":"PageCoordinatorDataSource"},"Classes/PageCoordinatorDataSource.html#/s:12XCoordinator25PageCoordinatorDataSourceC5pages4loopACSaySo16UIViewControllerCG_Sbtcfc":{"name":"init(pages:loop:)","abstract":"

Creates a PageCoordinatorDataSource with the given pages and looping capabilities.

","parent_name":"PageCoordinatorDataSource"},"Classes/PageCoordinatorDataSource.html#/c:@M@XCoordinator@objc(cs)PageCoordinatorDataSource(im)presentationCountForPageViewController:":{"name":"presentationCount(for:)","abstract":"

See UIPageViewControllerDataSource","parent_name":"PageCoordinatorDataSource"},"Classes/PageCoordinatorDataSource.html#/c:@M@XCoordinator@objc(cs)PageCoordinatorDataSource(im)presentationIndexForPageViewController:":{"name":"presentationIndex(for:)","abstract":"

See UIPageViewControllerDataSource","parent_name":"PageCoordinatorDataSource"},"Classes/PageCoordinatorDataSource.html#/c:@M@XCoordinator@objc(cs)PageCoordinatorDataSource(im)pageViewController:viewControllerBeforeViewController:":{"name":"pageViewController(_:viewControllerBefore:)","abstract":"

See UIPageViewControllerDataSource","parent_name":"PageCoordinatorDataSource"},"Classes/PageCoordinatorDataSource.html#/c:@M@XCoordinator@objc(cs)PageCoordinatorDataSource(im)pageViewController:viewControllerAfterViewController:":{"name":"pageViewController(_:viewControllerAfter:)","abstract":"

See UIPageViewControllerDataSource","parent_name":"PageCoordinatorDataSource"},"Classes/PageCoordinator.html#/s:12XCoordinator15PageCoordinatorC10dataSourceSo024UIPageViewControllerDataE0_pvp":{"name":"dataSource","abstract":"

The dataSource of the rootViewController.

","parent_name":"PageCoordinator"},"Classes/PageCoordinator.html#/s:12XCoordinator15PageCoordinatorC18rootViewController5pages4loop3set9directionACyxGSo06UIPageeF0C_SayAA11Presentable_pGSbAaL_pSgSo0keF19NavigationDirectionVtcfc":{"name":"init(rootViewController:pages:loop:set:direction:)","abstract":"

Creates a PageCoordinator with several sequential (potentially looping) pages.

","parent_name":"PageCoordinator"},"Classes/PageCoordinator.html#/s:12XCoordinator15PageCoordinatorC18rootViewController10dataSource3set9directionACyxGSo06UIPageeF0C_So0kef4DataH0_pAA11Presentable_pSo0keF19NavigationDirectionVtcfc":{"name":"init(rootViewController:dataSource:set:direction:)","abstract":"

Creates a PageCoordinator with a custom dataSource.","parent_name":"PageCoordinator"},"Classes/NavigationCoordinator.html#/s:12XCoordinator21NavigationCoordinatorC17animationDelegateAA0b9AnimationE0Cvp":{"name":"animationDelegate","abstract":"

The animation delegate controlling the rootViewController’s transition animations.","parent_name":"NavigationCoordinator"},"Classes/NavigationCoordinator.html#/s:12XCoordinator21NavigationCoordinatorC8delegateSo30UINavigationControllerDelegate_pSgvp":{"name":"delegate","abstract":"

This represents a fallback-delegate to be notified about navigation controller events.","parent_name":"NavigationCoordinator"},"Classes/NavigationCoordinator.html#/s:12XCoordinator21NavigationCoordinatorC18rootViewController12initialRouteACyxGSo012UINavigationF0C_xSgtcfc":{"name":"init(rootViewController:initialRoute:)","abstract":"

Creates a NavigationCoordinator and optionally triggers an initial route.

","parent_name":"NavigationCoordinator"},"Classes/NavigationCoordinator.html#/s:12XCoordinator21NavigationCoordinatorC18rootViewController0D0ACyxGSo012UINavigationF0C_AA11Presentable_ptcfc":{"name":"init(rootViewController:root:)","abstract":"

Creates a NavigationCoordinator and pushes a presentable onto the navigation stack right away.

","parent_name":"NavigationCoordinator"},"Classes/NavigationAnimationDelegate.html#/s:12XCoordinator27NavigationAnimationDelegateC17velocityThreshold12CoreGraphics7CGFloatVvp":{"name":"velocityThreshold","abstract":"

The velocity threshold needed for the interactive pop transition to succeed

","parent_name":"NavigationAnimationDelegate"},"Classes/NavigationAnimationDelegate.html#/s:12XCoordinator27NavigationAnimationDelegateC27transitionProgressThreshold12CoreGraphics7CGFloatVvp":{"name":"transitionProgressThreshold","abstract":"

The transition progress threshold for the interactive pop transition to succeed

","parent_name":"NavigationAnimationDelegate"},"Classes/NavigationAnimationDelegate.html#/c:@CM@XCoordinator@objc(cs)NavigationAnimationDelegate(im)navigationController:interactionControllerForAnimationController:":{"name":"navigationController(_:interactionControllerFor:)","abstract":"

See UINavigationControllerDelegate documentation","parent_name":"NavigationAnimationDelegate"},"Classes/NavigationAnimationDelegate.html#/c:@CM@XCoordinator@objc(cs)NavigationAnimationDelegate(im)navigationController:animationControllerForOperation:fromViewController:toViewController:":{"name":"navigationController(_:animationControllerFor:from:to:)","abstract":"

See UINavigationControllerDelegate documentation","parent_name":"NavigationAnimationDelegate"},"Classes/NavigationAnimationDelegate.html#/c:@CM@XCoordinator@objc(cs)NavigationAnimationDelegate(im)navigationController:didShowViewController:animated:":{"name":"navigationController(_:didShow:animated:)","abstract":"

See UINavigationControllerDelegate documentation","parent_name":"NavigationAnimationDelegate"},"Classes/NavigationAnimationDelegate.html#/c:@CM@XCoordinator@objc(cs)NavigationAnimationDelegate(im)navigationController:willShowViewController:animated:":{"name":"navigationController(_:willShow:animated:)","abstract":"

See UINavigationControllerDelegate documentation","parent_name":"NavigationAnimationDelegate"},"Classes/NavigationAnimationDelegate.html#/c:@CM@XCoordinator@objc(cs)NavigationAnimationDelegate(im)gestureRecognizerShouldBegin:":{"name":"gestureRecognizerShouldBegin(_:)","abstract":"

See UIGestureRecognizerDelegate documentation","parent_name":"NavigationAnimationDelegate"},"Classes/NavigationAnimationDelegate.html#/c:@CM@XCoordinator@objc(cs)NavigationAnimationDelegate(im)handleInteractivePopGestureRecognizer:":{"name":"handleInteractivePopGestureRecognizer(_:)","abstract":"

This method handles changes of the navigation controller’s interactivePopGestureRecognizer.

","parent_name":"NavigationAnimationDelegate"},"Classes/NavigationAnimationDelegate.html#/s:12XCoordinator27NavigationAnimationDelegateC25setupPopGestureRecognizer3forySo22UINavigationControllerC_tF":{"name":"setupPopGestureRecognizer(for:)","abstract":"

This method sets up the interactivePopGestureRecognizer of the navigation controller","parent_name":"NavigationAnimationDelegate"},"Classes/InterruptibleTransitionAnimation.html#/s:12XCoordinator32InterruptibleTransitionAnimationC8duration16generateAnimator0F21InteractionControllerACSd_So25UIViewImplicitlyAnimating_pSo0jI20ContextTransitioning_pcAA013PercentDrivenhI0_pSgyctcfc":{"name":"init(duration:generateAnimator:generateInteractionController:)","abstract":"

Creates an interruptible transition animation based on duration, an animator generator closure","parent_name":"InterruptibleTransitionAnimation"},"Classes/InterruptibleTransitionAnimation.html#/s:12XCoordinator32InterruptibleTransitionAnimationC8duration16generateAnimatorACSd_So25UIViewImplicitlyAnimating_pSo0H30ControllerContextTransitioning_pctcfc":{"name":"init(duration:generateAnimator:)","abstract":"

Creates an interruptible transition animation based on duration and an animator generator closure.

","parent_name":"InterruptibleTransitionAnimation"},"Classes/InterruptibleTransitionAnimation.html#/s:12XCoordinator32InterruptibleTransitionAnimationC08generateB8Animator5usingSo25UIViewImplicitlyAnimating_pSo0H30ControllerContextTransitioning_p_tF":{"name":"generateInterruptibleAnimator(using:)","abstract":"

Generates an interruptible animator based on the transitionContext.","parent_name":"InterruptibleTransitionAnimation"},"Classes/InterruptibleTransitionAnimation.html#/c:@M@XCoordinator@objc(cs)InterruptibleTransitionAnimation(im)animateTransition:":{"name":"animateTransition(using:)","abstract":"

See UIViewControllerAnimatedTransitioning","parent_name":"InterruptibleTransitionAnimation"},"Classes/InterruptibleTransitionAnimation.html#/c:@M@XCoordinator@objc(cs)InterruptibleTransitionAnimation(im)interruptibleAnimatorForTransition:":{"name":"interruptibleAnimator(using:)","abstract":"

See UIViewControllerAnimatedTransitioning","parent_name":"InterruptibleTransitionAnimation"},"Classes/InteractiveTransitionAnimation.html#/s:12XCoordinator19TransitionAnimationP21interactionControllerAA024PercentDrivenInteractionE0_pSgvp":{"name":"interactionController","parent_name":"InteractiveTransitionAnimation"},"Classes/InteractiveTransitionAnimation.html#/s:12XCoordinator30InteractiveTransitionAnimationC8duration10transition29generateInteractionControllerACSd_ySo06UIViewI20ContextTransitioning_pcAA013PercentDrivenhI0_pSgyctcfc":{"name":"init(duration:transition:generateInteractionController:)","abstract":"

Creates an InteractiveTransitionAnimation with a duration, an animation closure and a closure to","parent_name":"InteractiveTransitionAnimation"},"Classes/InteractiveTransitionAnimation.html#/s:12XCoordinator30InteractiveTransitionAnimationC8duration10transitionACSd_ySo36UIViewControllerContextTransitioning_pctcfc":{"name":"init(duration:transition:)","abstract":"

Convenience initializer for init(duration:transition:generateInteractionController:).","parent_name":"InteractiveTransitionAnimation"},"Classes/InteractiveTransitionAnimation.html#/s:12XCoordinator30InteractiveTransitionAnimationC010transitionD029generateInteractionControllerAcA06StaticcD0C_AA013PercentDrivengH0_pSgyctcfc":{"name":"init(transitionAnimation:generateInteractionController:)","abstract":"

Convenience initializer for init(duration:transition:generateInteractionController:).","parent_name":"InteractiveTransitionAnimation"},"Classes/InteractiveTransitionAnimation.html#/s:12XCoordinator30InteractiveTransitionAnimationC010transitionD0AcA06StaticcD0C_tcfc":{"name":"init(transitionAnimation:)","abstract":"

Convenience initializer for init(duration:transition:).","parent_name":"InteractiveTransitionAnimation"},"Classes/InteractiveTransitionAnimation.html#/c:@M@XCoordinator@objc(cs)InteractiveTransitionAnimation(im)transitionDuration:":{"name":"transitionDuration(using:)","abstract":"

See UIViewControllerAnimatedTransitioning","parent_name":"InteractiveTransitionAnimation"},"Classes/InteractiveTransitionAnimation.html#/c:@M@XCoordinator@objc(cs)InteractiveTransitionAnimation(im)animateTransition:":{"name":"animateTransition(using:)","abstract":"

See UIViewControllerAnimatedTransitioning","parent_name":"InteractiveTransitionAnimation"},"Classes/InteractiveTransitionAnimation.html#/s:12XCoordinator30InteractiveTransitionAnimationC29generateInteractionControllerAA013PercentDrivenfG0_pSgyF":{"name":"generateInteractionController()","abstract":"

This method is used to generate an applicable interaction controller.

","parent_name":"InteractiveTransitionAnimation"},"Classes/InteractiveTransitionAnimation.html#/s:12XCoordinator30InteractiveTransitionAnimationC5startyyF":{"name":"start()","abstract":"

Starts the transition animation by generating an interaction controller.

","parent_name":"InteractiveTransitionAnimation"},"Classes/InteractiveTransitionAnimation.html#/s:12XCoordinator30InteractiveTransitionAnimationC7cleanupyyF":{"name":"cleanup()","abstract":"

Ends the transition animation by deleting the interaction controller.

","parent_name":"InteractiveTransitionAnimation"},"Classes/BasicCoordinator/InitialLoadingType.html#/s:12XCoordinator16BasicCoordinatorC18InitialLoadingTypeO11immediatelyyAEyxq__GAGmAA5RouteRzAA18TransitionProtocolR_r0_lF":{"name":"immediately","abstract":"

The initial route is triggered before the coordinator is made visible (i.e. on initialization).

","parent_name":"InitialLoadingType"},"Classes/BasicCoordinator/InitialLoadingType.html#/s:12XCoordinator16BasicCoordinatorC18InitialLoadingTypeO9presentedyAEyxq__GAGmAA5RouteRzAA18TransitionProtocolR_r0_lF":{"name":"presented","abstract":"

The initial route is triggered after the coordinator is made visible.

","parent_name":"InitialLoadingType"},"Classes/BasicCoordinator/InitialLoadingType.html":{"name":"InitialLoadingType","abstract":"

InitialLoadingType differentiates between different points in time when the initital route is to","parent_name":"BasicCoordinator"},"Classes/BasicCoordinator.html#/s:12XCoordinator16BasicCoordinatorC18rootViewController12initialRoute0G11LoadingType17prepareTransitionACyxq_G04RooteF0Qy__xSgAC07InitialiJ0Oyxq__Gq_xcSgtcfc":{"name":"init(rootViewController:initialRoute:initialLoadingType:prepareTransition:)","abstract":"

Creates a BasicCoordinator.

","parent_name":"BasicCoordinator"},"Classes/BasicCoordinator.html#/s:12XCoordinator16BasicCoordinatorC9presented4fromyAA11Presentable_pSg_tF":{"name":"presented(from:)","abstract":"

This method is called whenever the BasicCoordinator is shown to the user.

","parent_name":"BasicCoordinator"},"Classes/BasicCoordinator.html#/s:12XCoordinator16BasicCoordinatorC17prepareTransition3forq_x_tF":{"name":"prepareTransition(for:)","parent_name":"BasicCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator15BaseCoordinatorC8childrenSayAA11Presentable_pGvp":{"name":"children","abstract":"

The child coordinators that are currently in the view hierarchy.","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator19TransitionPerformerP18rootViewController0B4Type_04RooteF0QZvp":{"name":"rootViewController","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator11PresentableP14viewControllerSo06UIViewD0CSgvp":{"name":"viewController","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator15BaseCoordinatorC18rootViewController12initialRouteACyxq_G04RooteF0Qy__xSgtcfc":{"name":"init(rootViewController:initialRoute:)","abstract":"

This initializer trigger a route before the coordinator is made visible.

","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator15BaseCoordinatorC18rootViewController17initialTransitionACyxq_G04RooteF0Qy__q_Sgtcfc":{"name":"init(rootViewController:initialTransition:)","abstract":"

This initializer performs a transition before the coordinator is made visible.

","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator11PresentableP9presented4fromyAaB_pSg_tF":{"name":"presented(from:)","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator11CoordinatorP22removeChildrenIfNeededyyF":{"name":"removeChildrenIfNeeded()","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator11CoordinatorP8addChildyyAA11Presentable_pF":{"name":"addChild(_:)","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator11CoordinatorP11removeChildyyAA11Presentable_pF":{"name":"removeChild(_:)","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator15BaseCoordinatorC17prepareTransition3forq_x_tF":{"name":"prepareTransition(for:)","abstract":"

This method prepares transitions for routes.","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator11PresentableP14registerParentyyAaB_XlF":{"name":"registerParent(_:)","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator15BaseCoordinatorC18RootViewControllera":{"name":"RootViewController","abstract":"

Shortcut for BaseCoordinator.TransitionType.RootViewController

","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator15BaseCoordinatorC29registerInteractiveTransition3for11triggeredBy7handler10completionyx_qd__yqd___AA0F9Animation_pSgyXEtcyycSgtSo19UIGestureRecognizerCRbd__lF":{"name":"registerInteractiveTransition(for:triggeredBy:handler:completion:)","abstract":"

Register an interactive transition triggered by a gesture recognizer.

","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator15BaseCoordinatorC29registerInteractiveTransition3for11triggeredBy8progress12shouldFinish10completionyx_qd__12CoreGraphics7CGFloatVqd__cSbqd__cyycSgtSo19UIGestureRecognizerCRbd__lF":{"name":"registerInteractiveTransition(for:triggeredBy:progress:shouldFinish:completion:)","abstract":"

Register an interactive transition triggered by a gesture recognizer.

","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator15BaseCoordinatorC32unregisterInteractiveTransitions11triggeredByySo19UIGestureRecognizerC_tF":{"name":"unregisterInteractiveTransitions(triggeredBy:)","abstract":"

Unregisters a previously registered interactive transition.

","parent_name":"BaseCoordinator"},"Classes/AnyTransitionPerformer.html#/s:12XCoordinator11PresentableP14viewControllerSo06UIViewD0CSgvp":{"name":"viewController","parent_name":"AnyTransitionPerformer"},"Classes/AnyTransitionPerformer.html#/s:12XCoordinator19TransitionPerformerP18rootViewController0B4Type_04RooteF0QZvp":{"name":"rootViewController","parent_name":"AnyTransitionPerformer"},"Classes/AnyTransitionPerformer.html#/s:12XCoordinator11PresentableP9presented4fromyAaB_pSg_tF":{"name":"presented(from:)","parent_name":"AnyTransitionPerformer"},"Classes/AnyTransitionPerformer.html#/s:12XCoordinator19TransitionPerformerP07performB0_4with10completiony0B4TypeQz_AA0B7OptionsVyycSgtF":{"name":"performTransition(_:with:completion:)","parent_name":"AnyTransitionPerformer"},"Classes/AnyCoordinator.html#/s:12XCoordinator14AnyCoordinatorCyACyxq_Gqd__c9RouteTypeQyd__Rsz010TransitionE0Qyd__Rs_AA0C0Rd__lufc":{"name":"init(_:)","abstract":"

Creates a type-erased Coordinator for a specific coordinator.

","parent_name":"AnyCoordinator"},"Classes/AnyCoordinator.html#/s:12XCoordinator19TransitionPerformerP18rootViewController0B4Type_04RooteF0QZvp":{"name":"rootViewController","parent_name":"AnyCoordinator"},"Classes/AnyCoordinator.html#/s:12XCoordinator11PresentableP14viewControllerSo06UIViewD0CSgvp":{"name":"viewController","parent_name":"AnyCoordinator"},"Classes/AnyCoordinator.html#/s:12XCoordinator14AnyCoordinatorC17prepareTransition3forq_x_tF":{"name":"prepareTransition(for:)","abstract":"

Prepare and return transitions for a given route.

","parent_name":"AnyCoordinator"},"Classes/AnyCoordinator.html#/s:12XCoordinator11PresentableP9presented4fromyAaB_pSg_tF":{"name":"presented(from:)","parent_name":"AnyCoordinator"},"Classes/AnyCoordinator.html#/s:12XCoordinator11PresentableP14registerParentyyAaB_XlF":{"name":"registerParent(_:)","parent_name":"AnyCoordinator"},"Classes/AnyCoordinator.html#/s:12XCoordinator11PresentableP7setRoot3forySo8UIWindowC_tF":{"name":"setRoot(for:)","parent_name":"AnyCoordinator"},"Classes/AnyCoordinator.html#/s:12XCoordinator11CoordinatorP8addChildyyAA11Presentable_pF":{"name":"addChild(_:)","parent_name":"AnyCoordinator"},"Classes/AnyCoordinator.html#/s:12XCoordinator11CoordinatorP11removeChildyyAA11Presentable_pF":{"name":"removeChild(_:)","parent_name":"AnyCoordinator"},"Classes/AnyCoordinator.html#/s:12XCoordinator11CoordinatorP22removeChildrenIfNeededyyF":{"name":"removeChildrenIfNeeded()","parent_name":"AnyCoordinator"},"Classes/Animation.html#/s:12XCoordinator9AnimationC7defaultACvpZ":{"name":"default","abstract":"

Use Animation.default to override currently set animations","parent_name":"Animation"},"Classes/Animation.html#/s:12XCoordinator9AnimationC012presentationB0AA010TransitionB0_pSgvp":{"name":"presentationAnimation","abstract":"

The transition animation performed when transitioning to a presentable.

","parent_name":"Animation"},"Classes/Animation.html#/s:12XCoordinator9AnimationC09dismissalB0AA010TransitionB0_pSgvp":{"name":"dismissalAnimation","abstract":"

The transition animation performed when transitioning away from a presentable.

","parent_name":"Animation"},"Classes/Animation.html#/s:12XCoordinator9AnimationC12presentation9dismissalAcA010TransitionB0_pSg_AGtcfc":{"name":"init(presentation:dismissal:)","abstract":"

Creates an Animation object containing a presentation and a dismissal animation.

","parent_name":"Animation"},"Classes/Animation.html#/c:@CM@XCoordinator@objc(cs)Animation(im)animationControllerForPresentedController:presentingController:sourceController:":{"name":"animationController(forPresented:presenting:source:)","abstract":"

See UIViewControllerTransitioningDelegate","parent_name":"Animation"},"Classes/Animation.html#/c:@CM@XCoordinator@objc(cs)Animation(im)animationControllerForDismissedController:":{"name":"animationController(forDismissed:)","abstract":"

See UIViewControllerTransitioningDelegate","parent_name":"Animation"},"Classes/Animation.html#/c:@CM@XCoordinator@objc(cs)Animation(im)interactionControllerForPresentation:":{"name":"interactionControllerForPresentation(using:)","abstract":"

See UIViewControllerTransitioningDelegate","parent_name":"Animation"},"Classes/Animation.html#/c:@CM@XCoordinator@objc(cs)Animation(im)interactionControllerForDismissal:":{"name":"interactionControllerForDismissal(using:)","abstract":"

See UIViewControllerTransitioningDelegate","parent_name":"Animation"},"Classes/Animation.html":{"name":"Animation","abstract":"

Animation is used to set presentation and dismissal animations for presentables.

"},"Classes/AnyCoordinator.html":{"name":"AnyCoordinator","abstract":"

AnyCoordinator is a type-erased Coordinator (RouteType & TransitionType) and"},"Classes/AnyTransitionPerformer.html":{"name":"AnyTransitionPerformer","abstract":"

AnyTransitionPerformer can be used as an abstraction from a specific TransitionPerformer implementation"},"Classes/BaseCoordinator.html":{"name":"BaseCoordinator","abstract":"

BaseCoordinator can (and is encouraged to) be used as a superclass for any custom implementation of a coordinator.

"},"Classes/BasicCoordinator.html":{"name":"BasicCoordinator","abstract":"

BasicCoordinator is a coordinator class that can be used without subclassing.

"},"Classes/InteractiveTransitionAnimation.html":{"name":"InteractiveTransitionAnimation","abstract":"

InteractiveTransitionAnimation provides a simple interface to create interactive transition animations.

"},"Classes/InterruptibleTransitionAnimation.html":{"name":"InterruptibleTransitionAnimation","abstract":"

Use InterruptibleTransitionAnimation to define interactive transitions based on the"},"Classes/NavigationAnimationDelegate.html":{"name":"NavigationAnimationDelegate","abstract":"

NavigationAnimationDelegate is used as the delegate of a NavigationCoordinator’s rootViewController"},"Classes/NavigationCoordinator.html":{"name":"NavigationCoordinator","abstract":"

NavigationCoordinator acts as a base class for custom coordinators with a UINavigationController"},"Classes/PageCoordinator.html":{"name":"PageCoordinator","abstract":"

PageCoordinator provides a base class for your custom coordinator with a UIPageViewController rootViewController.

"},"Classes/PageCoordinatorDataSource.html":{"name":"PageCoordinatorDataSource","abstract":"

PageCoordinatorDataSource is a"},"Classes/RedirectionRouter.html":{"name":"RedirectionRouter","abstract":"

RedirectionRouters can be used to extract routes into different route types."},"Classes/SplitCoordinator.html":{"name":"SplitCoordinator","abstract":"

SplitCoordinator can be used as a basis for a coordinator with a rootViewController of type"},"Classes/StaticTransitionAnimation.html":{"name":"StaticTransitionAnimation","abstract":"

StaticTransitionAnimation can be used to realize static transition animations.

"},"Classes/StrongRouter.html":{"name":"StrongRouter","abstract":"

StrongRouter is a type-erasure of a given Router object and, therefore, can be used as an abstraction from a specific Router"},"Classes/TabBarAnimationDelegate.html":{"name":"TabBarAnimationDelegate","abstract":"

TabBarAnimationDelegate is used as the delegate of a TabBarCoordinator’s rootViewController"},"Classes/TabBarCoordinator.html":{"name":"TabBarCoordinator","abstract":"

Use a TabBarCoordinator to coordinate a flow where a UITabbarController serves as a rootViewController."},"Classes/ViewCoordinator.html":{"name":"ViewCoordinator","abstract":"

ViewCoordinator is a base class for custom coordinators with a UIViewController rootViewController.

"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Extensions.html":{"name":"Extensions","abstract":"

The following extensions are available globally.

"},"Protocols.html":{"name":"Protocols","abstract":"

The following protocols are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"},"Typealiases.html":{"name":"Type Aliases","abstract":"

The following type aliases are available globally.

"}} \ No newline at end of file diff --git a/docs/docsets/XCoordinator.docset/Contents/Resources/docSet.dsidx b/docs/docsets/XCoordinator.docset/Contents/Resources/docSet.dsidx deleted file mode 100644 index 3e8f5057..00000000 Binary files a/docs/docsets/XCoordinator.docset/Contents/Resources/docSet.dsidx and /dev/null differ diff --git a/docs/docsets/XCoordinator.docset/icon.png b/docs/docsets/XCoordinator.docset/icon.png deleted file mode 100644 index c83fbf0f..00000000 Binary files a/docs/docsets/XCoordinator.docset/icon.png and /dev/null differ diff --git a/docs/img/carat.png b/docs/img/carat.png deleted file mode 100755 index 29d2f7fd..00000000 Binary files a/docs/img/carat.png and /dev/null differ diff --git a/docs/img/dash.png b/docs/img/dash.png deleted file mode 100755 index 6f694c7a..00000000 Binary files a/docs/img/dash.png and /dev/null differ diff --git a/docs/img/gh.png b/docs/img/gh.png deleted file mode 100755 index 628da97c..00000000 Binary files a/docs/img/gh.png and /dev/null differ diff --git a/docs/img/spinner.gif b/docs/img/spinner.gif deleted file mode 100644 index e3038d0a..00000000 Binary files a/docs/img/spinner.gif and /dev/null differ diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index 5aecef32..00000000 --- a/docs/index.html +++ /dev/null @@ -1,601 +0,0 @@ - - - - XCoordinator Reference - - - - - - - - - - - - - - - -
-

- - XCoordinator Docs - - -

- -

-

- -
-

- -

- - - View on GitHub - -

- -
- -

- XCoordinator Reference - - XCoordinator Reference -

- -
- -
- -
-
- -

- -

-

Build Status CocoaPods Compatible Carthage Compatible Documentation Platform License

- -

⚠️ We have recently released XCoordinator 2.0. Make sure to read this section before migrating. In general, please replace all AnyRouter by either UnownedRouter (in viewControllers, viewModels or references to parent coordinators) or StrongRouter in your AppDelegate or for references to child coordinators. In addition to that, the rootViewController is now injected into the initializer instead of being created in the Coordinator.generateRootViewController method.

- -

“How does an app transition from one view controller to another?”. -This question is common and puzzling regarding iOS development. There are many answers, as every architecture has different implementation variations. Some do it from within the implementation of a view controller, while some use a router/coordinator, an object connecting view models.

- -

To better answer the question, we are building XCoordinator, a navigation framework based on the Coordinator pattern. -It’s especially useful for implementing MVVM-C, Model-View-ViewModel-Coordinator:

- -

- -

-

🏃‍♂️Getting started

- -

Create an enum with all of the navigation paths for a particular flow, i.e. a group of closely connected scenes. (It is up to you when to create a Route/Coordinator. As our rule of thumb, create a new Route/Coordinator whenever a new root view controller, e.g. a new navigation controller or a tab bar controller, is needed.).

- -

Whereas the Route describes which routes can be triggered in a flow, the Coordinator is responsible for the preparation of transitions based on routes being triggered. We could, therefore, prepare multiple coordinators for the same route, which differ in which transitions are executed for each route.

- -

In the following example, we create the UserListRoute enum to define triggers of a flow of our application. UserListRoute offers routes to open the home screen, display a list of users, to open a specific user and to log out. The UserListCoordinator is implemented to prepare transitions for the triggered routes. When a UserListCoordinator is shown, it triggers the .home route to display a HomeViewController.

-
enum UserListRoute: Route {
-    case home
-    case users
-    case user(String)
-    case registerUsersPeek(from: Container)
-    case logout
-}
-
-class UserListCoordinator: NavigationCoordinator<UserListRoute> {
-    init() {
-        super.init(initialRoute: .home)
-    }
-
-    override func prepareTransition(for route: UserListRoute) -> NavigationTransition {
-        switch route {
-        case .home:
-            let viewController = HomeViewController.instantiateFromNib()
-            let viewModel = HomeViewModelImpl(router: anyRouter)
-            viewController.bind(to: viewModel)
-            return .push(viewController)
-        case .users:
-            let viewController = UsersViewController.instantiateFromNib()
-            let viewModel = UsersViewModelImpl(router: anyRouter)
-            viewController.bind(to: viewModel)
-            return .push(viewController, animation: .interactiveFade)
-        case .user(let username):
-            let coordinator = UserCoordinator(user: username)
-            return .present(coordinator, animation: .default)
-        case .registerUsersPeek(let source):
-            return registerPeek(for: source, route: .users)
-        case .logout:
-            return .dismiss()
-        }
-    }
-}
-
- -

Routes are triggered from within Coordinators or ViewModels. In the following, we describe how to trigger routes from within a ViewModel. The router of the current flow is injected into the ViewModel.

-
class HomeViewModel {
-    let router: UnownedRouter<HomeRoute>
-
-    init(router: UnownedRouter<HomeRoute>) {
-        self.router = router
-    }
-
-    /* ... */
-
-    func usersButtonPressed() {
-        router.trigger(.users)
-    }
-}
-
-

🏗 Organizing an app’s structure with XCoordinator

- -

In general, an app’s structure is defined by nesting coordinators and view controllers. You can transition (i.e. push, present, pop, dismiss) to a different coordinator whenever your app changes to a different flow. Within a flow, we transition between viewControllers.

- -

Example: In UserListCoordinator.prepareTransition(for:) we change from the UserListRoute to the UserRoute whenever the UserListRoute.user route is triggered. By dismissing a viewController in UserListRoute.logout, we additionally switch back to the previous flow - in this case the HomeRoute.

- -

To achieve this behavior, every Coordinator has its own rootViewController. This would be a UINavigationController in the case of a NavigationCoordinator, a UITabBarController in the case of a TabBarCoordinator, etc. When transitioning to a Coordinator/Router, this rootViewController is used as the destination view controller.

-

🏁 Using XCoordinator from App Launch

- -

To use coordinators from the launch of the app, make sure to create the app’s window programmatically in AppDelegate.swift (Don’t forget to remove Main Storyboard file base name from Info.plist). Then, set the coordinator as the root of the window‘s view hierarchy in the AppDelegate.didFinishLaunching. Make sure to hold a strong reference to your app’s initial coordinator or a strongRouter reference.

-
@UIApplicationMain
-class AppDelegate: UIResponder, UIApplicationDelegate {
-    let window: UIWindow! = UIWindow()
-    let router = AppCoordinator().strongRouter
-
-    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
-        router.setRoot(for: window)
-        return true
-    }
-}
-
-

🤸‍♂️ Extras

- -

For more advanced use, XCoordinator offers many more customization options. We introduce custom animated transitions and deep linking. Furthermore, extensions for use in reactive programming with RxSwift/Combine and options to split up huge routes are described.

-

🌗 Custom Transitions

- -

Custom animated transitions define presentation and dismissal animations. You can specify Animation objects in prepareTransition(for:) in your coordinator for several common transitions, such as present, dismiss, push and pop. Specifying no animation (nil) results in not overriding previously set animations. Use Animation.default to reset previously set animation to the default animations UIKit offers.

-
class UsersCoordinator: NavigationCoordinator<UserRoute> {
-
-    /* ... */
-
-    override func prepareTransition(for route: UserRoute) -> NavigationTransition {
-        switch route {
-        case .user(let name):
-            let animation = Animation(
-                presentationAnimation: YourAwesomePresentationTransitionAnimation(),
-                dismissalAnimation: YourAwesomeDismissalTransitionAnimation()
-            )
-            let viewController = UserViewController.instantiateFromNib()
-            let viewModel = UserViewModelImpl(coordinator: coordinator, name: name)
-            viewController.bind(to: viewModel)
-            return .push(viewController, animation: animation)
-        /* ... */
-        }
-    }
-}
-
-

🛤 Deep Linking

- -

Deep Linking can be used to chain different routes together. In contrast to the .multiple transition, deep linking can identify routers based on previous transitions (e.g. when pushing or presenting a router), which enables chaining of routes of different types. Keep in mind, that you cannot access higher-level routers anymore once you trigger a route on a lower level of the router hierarchy.

-
class AppCoordinator: NavigationCoordinator<AppRoute> {
-
-    /* ... */
-
-    override func prepareTransition(for route: AppRoute) -> NavigationTransition {
-        switch route {
-        /* ... */
-        case .deep:
-            return deepLink(AppRoute.login, AppRoute.home, HomeRoute.news, HomeRoute.dismiss)
-        }
-    }
-}
-
- -

⚠️ XCoordinator does not check at compile-time, whether a deep link can be executed. Rather it uses assertionFailures to inform about incorrect chaining at runtime, when it cannot find an appriopriate router for a given route. Keep this in mind when changing the structure of your app.

-

🚏 RedirectionRouter

- -

Let’s assume, there is a route type called HugeRoute with more than 10 routes. To decrease coupling, HugeRoute needs to be split up into mutliple route types. As you will discover, many routes in HugeRoute use transitions dependent on a specific rootViewController, such as push, show, pop, etc. If splitting up routes by introducing a new router/coordinator is not an option, XCoordinator has two solutions for you to solve such a case: RedirectionRouter or using multiple coordinators with the same rootViewController (see this section for more information).

- -

A RedirectionRouter can be used to map a new route type onto a generalized ParentRoute. A RedirectionRouter is independent of the TransitionType of its parent router. You can use RedirectionRouter.init(viewController:parent:map:) or subclassing by overriding mapToParentRoute(_:) to create a RedirectionRouter.

- -

The following code example illustrates how a RedirectionRouter is initialized and used.

-
class ParentCoordinator: NavigationCoordinator<ParentRoute> {
-    /* ... */
-
-    override func prepareTransition(for route: ParentRoute) -> NavigationTransition {
-        switch route {
-        /* ... */
-        case .subCoordinator:
-            let subCoordinator = SubCoordinator(parent: unownedRouter)
-            return .push(subCoordinator)
-        }
-    }
-}
-
-class ChildCoordinator: RedirectionRouter<ParentRoute, ChildRoute> {
-    init(parent: UnownedRouter<ParentRoute>) {
-        let viewController = UIViewController() 
-        // this viewController is used when performing transitions with the Subcoordinator directly.
-        super.init(viewController: viewController, parent: parent, map: nil)
-    }
-
-    /* ... */
-
-    override func mapToSuperRoute(for route: ChildRoute) -> ParentRoute {
-        // you can map your ChildRoute enum to ParentRoute cases here that will get triggered on the parent router.
-    }
-}
-
-

🚏Using multiple coordinators with the same rootViewController

- -

With XCoordinator 2.0, we introduce the option to use different coordinators with the same rootViewController. -Since you can specify the rootViewController in the initializer of a new coordinator, you can specify an existing coordinator’s rootViewController as in the following:

-
class FirstCoordinator: NavigationCoordinator<FirstRoute> {
-    /* ... */
-
-    override func prepareTransition(for route: FirstRoute) -> NavigationTransition {
-        switch route {
-        case .secondCoordinator:
-            let secondCoordinator = SecondCoordinator(rootViewController: self.rootViewController)
-            addChild(secondCoordinator)
-            return .none() 
-            // you could also trigger a specific initial route at this point, 
-            // such as `.trigger(SecondRoute.initial, on: secondCoordinator)`
-        }
-    }
-}
-
- -

We suggest to not use initial routes in the initializers of sibling coordinators, but instead using the transition option in the FirstCoordinator instead.

- -

⚠️ If you perform transitions involving a sibling coordinator directly (e.g. pushing a sibling coordinator without overriding its viewController property), your app will most likely crash.

-

🚀 RxSwift/Combine extensions

- -

Reactive programming can be very useful to keep the state of view and model consistent in a MVVM architecture. Instead of relying on the completion handler of the trigger method available in any Router, you can also use our RxSwift-extension. In the example application, we use Actions (from the Action framework) to trigger routes on certain UI events - e.g. to trigger LoginRoute.home in LoginViewModel, when the login button is tapped.

-
class LoginViewModelImpl: LoginViewModel, LoginViewModelInput, LoginViewModelOutput {
-
-    private let router: UnownedRouter<AppRoute>
-
-    private lazy var loginAction = CocoaAction { [unowned self] in
-        return self.router.rx.trigger(.home)
-    }
-
-    /* ... */
-}
-
-
- -

In addition to the above-mentioned approach, the reactive trigger extension can also be used to sequence different transitions by using the flatMap operator, as can be seen in the following:

-
let doneWithBothTransitions = 
-    router.rx.trigger(.home)
-        .flatMap { [unowned router] in router.rx.trigger(.news) }
-        .map { true }
-        .startWith(false)
-
- -

When using XCoordinator with the Combine extensions, you can use router.publishers.trigger instead of router.rx.trigger.

-

📚 Documentation & Example app

- -

To get more information about XCoordinator, check out the documentation. -Additionally, this repository serves as an example project using a MVVM architecture with XCoordinator.

- -

For a MVC example app, have a look at a workshop we did with a previous version of XCoordinator.

-

👨‍✈️ Why coordinators

- -
    -
  • Separation of responsibilities with the coordinator being the only component knowing anything related to the flow of your application.
    • -
  • Reusable Views and ViewModels because they do not contain any navigation logic.
    • -

  • Less coupling between components

    • -

  • Changeable navigation: Each coordinator is only responsible for one component and does not need to make assumptions about its parent. It can therefore be placed wherever we want to.

    • -
- -
-

The Coordinator by Soroush Khanlou

-
-

⁉️ Why XCoordinator

- -
    -
  • Actual navigation code is already written and abstracted away.
    • -
  • Clear separation of concerns: - -
      -
    • Coordinator: Coordinates routing of a set of routes.
      • -
    • Route: Describes navigation path.
      • -
    • Transition: Describe transition type and animation to new view.
      • -
    • -
  • Reuse coordinators, routers and transitions in different combinations.
    • -
  • Full support for custom transitions/animations.
    • -
  • Support for embedding child views / container views.
    • -
  • Generic BasicCoordinator classes suitable for many use cases and therefore less need to write your own coordinators.
    • -
  • Full support for your own coordinator classes conforming to our Coordinator protocol - -
    • -
  • Generic AnyRouter type erasure class encapsulates all types of coordinators and routers supporting the same set of routes. Therefore you can easily replace coordinators.
    • -
  • Use of enum for routes gives you autocompletion and type safety to perform only transition to routes supported by the coordinator.
    • -
-

🔩 Components

-

🎢 Route

- -

Describes possible navigation paths within a flow, a collection of closely related scenes.

-

👨‍✈️ Coordinator / Router

- -

An object loading views and creating viewModels based on triggered routes. A Coordinator creates and performs transitions to these scenes based on the data transferred via the route. In contrast to the coordinator, a router can be seen as an abstraction from that concept limited to triggering routes. Often, a Router is used to abstract from a specific coordinator in ViewModels.

-

When to use which Router abstraction

- -

You can create different router abstractions using the unownedRouter, weakRouter or strongRouter properties of your Coordinator. -You can decide between the following router abstractions of your coordinator:

- -
    -
  • StrongRouter holds a strong reference to the original coordinator. You can use this to hold child coordinators or to specify a certain router in the AppDelegate.
    • -
  • WeakRouter holds a weak reference to the original coordinator. You can use this to hold a coordinator in a viewController or viewModel. It can also be used to keep a reference to a sibling or parent coordinator.
    • -
  • UnownedRouter holds an unowned reference to the original coordinator. You can use this to hold a coordinator in a viewController or viewModel. It can also be used to keep a reference to a sibling or parent coordinator.
    • -
- -

If you want to know more about the differences on how references can be held, have a look here.

-

🌗 Transition

- -

Transitions describe the navigation from one view to another. Transitions are available based on the type of the root view controller in use. Example: Whereas ViewTransition only supports basic transitions that every root view controller supports, NavigationTransition adds navigation controller specific transitions.

- -

The available transition types include:

- -
    -
  • present presents a view controller on top of the view hierarchy - use presentOnRoot in case you want to present from the root view controller
    • -
  • embed embeds a view controller into a container view
    • -
  • dismiss dismisses the top most presented view controller - use dismissToRoot to call dismiss on the root view controller
    • -
  • none does nothing, may be used to ignore routes or for testing purposes
    • -
  • push pushes a view controller to the navigation stack (only in NavigationTransition)
    • -
  • pop pops the top view controller from the navigation stack (only in NavigationTransition)
    • -
  • popToRoot pops all the view controllers on the navigation stack except the root view controller (only in NavigationTransition)
    • -
- -

XCoordinator additionally supports common transitions for UITabBarController, UISplitViewController and UIPageViewController root view controllers.

-

🛠 Installation

-

CocoaPods

- -

To integrate XCoordinator into your Xcode project using CocoaPods, add this to your Podfile:

-
pod 'XCoordinator', '~> 2.0'
-
- -

To use the RxSwift extensions, add this to your Podfile:

-
pod 'XCoordinator/RxSwift', '~> 2.0'
-
- -

To use the Combine extensions, add this to your Podfile:

-
pod 'XCoordinator/Combine', '~> 2.0'
-
-

Carthage

- -

To integrate XCoordinator into your Xcode project using Carthage, add this to your Cartfile:

-
github "quickbirdstudios/XCoordinator" ~> 2.0
-
- -

Then run carthage update.

- -

If this is your first time using Carthage in the project, you’ll need to go through some additional steps as explained over at Carthage.

-

Swift Package Manager

- -

See this WWDC presentation about more information how to adopt Swift packages in your app.

- -

Specify https://github.com/quickbirdstudios/XCoordinator.git as the XCoordinator package link. -You can then decide between three different frameworks, i.e. XCoordinator, XCoordinatorRx and XCoordinatorCombine. -While XCoordinator contains the main framework, you can choose XCoordinatorRx or XCoordinatorCombine to get RxSwift or Combine extensions as well.

-

Manually

- -

If you prefer not to use any of the dependency managers, you can integrate XCoordinator into your project manually, by downloading the source code and placing the files on your project directory.

-

👤 Author

- -

This framework is created with ❤️ by QuickBird Studios.

- -

To get more information on XCoordinator check out our blog post.

-

❤️ Contributing

- -

Open an issue if you need help, if you found a bug, or if you want to discuss a feature request. If you feel like having a chat about XCoordinator with the developers and other users, join our Slack Workspace.

- -

Open a PR if you want to make changes to XCoordinator.

-

📃 License

- -

XCoordinator is released under an MIT license. See License.md for more information.

- -
-
- - -
-
-
-

© 2019 Stefan Kofler & Paul Kraft. All rights reserved. (Last updated: 2019-09-18)

-

Generated by jazzy ♪♫ v0.11.0, a Realm project.

-
- -
- diff --git a/docs/js/jazzy.js b/docs/js/jazzy.js deleted file mode 100755 index c31dc05e..00000000 --- a/docs/js/jazzy.js +++ /dev/null @@ -1,59 +0,0 @@ -window.jazzy = {'docset': false} -if (typeof window.dash != 'undefined') { - document.documentElement.className += ' dash' - window.jazzy.docset = true -} -if (navigator.userAgent.match(/xcode/i)) { - document.documentElement.className += ' xcode' - window.jazzy.docset = true -} - -function toggleItem($link, $content) { - var animationDuration = 300; - $link.toggleClass('token-open'); - $content.slideToggle(animationDuration); -} - -function itemLinkToContent($link) { - return $link.parent().parent().next(); -} - -// On doc load + hash-change, open any targetted item -function openCurrentItemIfClosed() { - if (window.jazzy.docset) { - return; - } - var $link = $(`.token[href="${location.hash}"]`); - $content = itemLinkToContent($link); - if ($content.is(':hidden')) { - toggleItem($link, $content); - } -} - -$(openCurrentItemIfClosed); -$(window).on('hashchange', openCurrentItemIfClosed); - -// On item link ('token') click, toggle its discussion -$('.token').on('click', function(event) { - if (window.jazzy.docset) { - return; - } - var $link = $(this); - toggleItem($link, itemLinkToContent($link)); - - // Keeps the document from jumping to the hash. - var href = $link.attr('href'); - if (history.pushState) { - history.pushState({}, '', href); - } else { - location.hash = href; - } - event.preventDefault(); -}); - -// Clicks on links to the current, closed, item need to open the item -$("a:not('.token')").on('click', function() { - if (location == this.href) { - openCurrentItemIfClosed(); - } -}); diff --git a/docs/js/jazzy.search.js b/docs/js/jazzy.search.js deleted file mode 100644 index e3d1ab90..00000000 --- a/docs/js/jazzy.search.js +++ /dev/null @@ -1,70 +0,0 @@ -$(function(){ - var $typeahead = $('[data-typeahead]'); - var $form = $typeahead.parents('form'); - var searchURL = $form.attr('action'); - - function displayTemplate(result) { - return result.name; - } - - function suggestionTemplate(result) { - var t = '
'; - t += '' + result.name + ''; - if (result.parent_name) { - t += '' + result.parent_name + ''; - } - t += '
'; - return t; - } - - $typeahead.one('focus', function() { - $form.addClass('loading'); - - $.getJSON(searchURL).then(function(searchData) { - const searchIndex = lunr(function() { - this.ref('url'); - this.field('name'); - this.field('abstract'); - for (const [url, doc] of Object.entries(searchData)) { - this.add({url: url, name: doc.name, abstract: doc.abstract}); - } - }); - - $typeahead.typeahead( - { - highlight: true, - minLength: 3, - autoselect: true - }, - { - limit: 10, - display: displayTemplate, - templates: { suggestion: suggestionTemplate }, - source: function(query, sync) { - const lcSearch = query.toLowerCase(); - const results = searchIndex.query(function(q) { - q.term(lcSearch, { boost: 100 }); - q.term(lcSearch, { - boost: 10, - wildcard: lunr.Query.wildcard.TRAILING - }); - }).map(function(result) { - var doc = searchData[result.ref]; - doc.url = result.ref; - return doc; - }); - sync(results); - } - } - ); - $form.removeClass('loading'); - $typeahead.trigger('focus'); - }); - }); - - var baseURL = searchURL.slice(0, -"search.json".length); - - $typeahead.on('typeahead:select', function(e, result) { - window.location = baseURL + result.url; - }); -}); diff --git a/docs/js/jquery.min.js b/docs/js/jquery.min.js deleted file mode 100644 index a1c07fd8..00000000 --- a/docs/js/jquery.min.js +++ /dev/null @@ -1,2 +0,0 @@ -/*! jQuery v3.4.1 | (c) JS Foundation and other contributors | jquery.org/license */ -!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],E=C.document,r=Object.getPrototypeOf,s=t.slice,g=t.concat,u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType},x=function(e){return null!=e&&e===e.window},c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.4.1",k=function(e,t){return new k.fn.init(e,t)},p=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g;function d(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp($),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+$),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\([\\da-f]{1,6}"+M+"?|("+M+")|.)","ig"),ne=function(e,t,n){var r="0x"+t-65536;return r!=r||n?t:r<0?String.fromCharCode(r+65536):String.fromCharCode(r>>10|55296,1023&r|56320)},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(m.childNodes),m.childNodes),t[m.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&((e?e.ownerDocument||e:m)!==C&&T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!A[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&U.test(t)){(s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=k),o=(l=h(t)).length;while(o--)l[o]="#"+s+" "+xe(l[o]);c=l.join(","),f=ee.test(t)&&ye(e.parentNode)||e}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){A(t,!0)}finally{s===k&&e.removeAttribute("id")}}}return g(t.replace(B,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[k]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e.namespaceURI,n=(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:m;return r!==C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),m!==C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=k,!C.getElementsByName||!C.getElementsByName(k).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+k+"-]").length||v.push("~="),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+k+"+*").length||v.push(".#.+[+~]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",$)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},D=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)===(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e===C||e.ownerDocument===m&&y(m,e)?-1:t===C||t.ownerDocument===m&&y(m,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e===C?-1:t===C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]===m?-1:s[r]===m?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if((e.ownerDocument||e)!==C&&T(e),d.matchesSelector&&E&&!A[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){A(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=p[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&p(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?k.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?k.grep(e,function(e){return e===n!==r}):"string"!=typeof n?k.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(k.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||q,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:L.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof k?t[0]:t,k.merge(this,k.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),D.test(r[1])&&k.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(k):k.makeArray(e,this)}).prototype=k.fn,q=k(E);var H=/^(?:parents|prev(?:Until|All))/,O={children:!0,contents:!0,next:!0,prev:!0};function P(e,t){while((e=e[t])&&1!==e.nodeType);return e}k.fn.extend({has:function(e){var t=k(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i,ge={option:[1,""],thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?k.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;nx",y.noCloneChecked=!!me.cloneNode(!0).lastChild.defaultValue;var Te=/^key/,Ce=/^(?:mouse|pointer|contextmenu|drag|drop)|click/,Ee=/^([^.]*)(?:\.(.+)|)/;function ke(){return!0}function Se(){return!1}function Ne(e,t){return e===function(){try{return E.activeElement}catch(e){}}()==("focus"===t)}function Ae(e,t,n,r,i,o){var a,s;if("object"==typeof t){for(s in"string"!=typeof n&&(r=r||n,n=void 0),t)Ae(e,s,n,r,t[s],o);return e}if(null==r&&null==i?(i=n,r=n=void 0):null==i&&("string"==typeof n?(i=r,r=void 0):(i=r,r=n,n=void 0)),!1===i)i=Se;else if(!i)return e;return 1===o&&(a=i,(i=function(e){return k().off(e),a.apply(this,arguments)}).guid=a.guid||(a.guid=k.guid++)),e.each(function(){k.event.add(this,t,i,r,n)})}function De(e,i,o){o?(Q.set(e,i,!1),k.event.add(e,i,{namespace:!1,handler:function(e){var t,n,r=Q.get(this,i);if(1&e.isTrigger&&this[i]){if(r.length)(k.event.special[i]||{}).delegateType&&e.stopPropagation();else if(r=s.call(arguments),Q.set(this,i,r),t=o(this,i),this[i](),r!==(n=Q.get(this,i))||t?Q.set(this,i,!1):n={},r!==n)return e.stopImmediatePropagation(),e.preventDefault(),n.value}else r.length&&(Q.set(this,i,{value:k.event.trigger(k.extend(r[0],k.Event.prototype),r.slice(1),this)}),e.stopImmediatePropagation())}})):void 0===Q.get(e,i)&&k.event.add(e,i,ke)}k.event={global:{},add:function(t,e,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Q.get(t);if(v){n.handler&&(n=(o=n).handler,i=o.selector),i&&k.find.matchesSelector(ie,i),n.guid||(n.guid=k.guid++),(u=v.events)||(u=v.events={}),(a=v.handle)||(a=v.handle=function(e){return"undefined"!=typeof k&&k.event.triggered!==e.type?k.event.dispatch.apply(t,arguments):void 0}),l=(e=(e||"").match(R)||[""]).length;while(l--)d=g=(s=Ee.exec(e[l])||[])[1],h=(s[2]||"").split(".").sort(),d&&(f=k.event.special[d]||{},d=(i?f.delegateType:f.bindType)||d,f=k.event.special[d]||{},c=k.extend({type:d,origType:g,data:r,handler:n,guid:n.guid,selector:i,needsContext:i&&k.expr.match.needsContext.test(i),namespace:h.join(".")},o),(p=u[d])||((p=u[d]=[]).delegateCount=0,f.setup&&!1!==f.setup.call(t,r,h,a)||t.addEventListener&&t.addEventListener(d,a)),f.add&&(f.add.call(t,c),c.handler.guid||(c.handler.guid=n.guid)),i?p.splice(p.delegateCount++,0,c):p.push(c),k.event.global[d]=!0)}},remove:function(e,t,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Q.hasData(e)&&Q.get(e);if(v&&(u=v.events)){l=(t=(t||"").match(R)||[""]).length;while(l--)if(d=g=(s=Ee.exec(t[l])||[])[1],h=(s[2]||"").split(".").sort(),d){f=k.event.special[d]||{},p=u[d=(r?f.delegateType:f.bindType)||d]||[],s=s[2]&&new RegExp("(^|\\.)"+h.join("\\.(?:.*\\.|)")+"(\\.|$)"),a=o=p.length;while(o--)c=p[o],!i&&g!==c.origType||n&&n.guid!==c.guid||s&&!s.test(c.namespace)||r&&r!==c.selector&&("**"!==r||!c.selector)||(p.splice(o,1),c.selector&&p.delegateCount--,f.remove&&f.remove.call(e,c));a&&!p.length&&(f.teardown&&!1!==f.teardown.call(e,h,v.handle)||k.removeEvent(e,d,v.handle),delete u[d])}else for(d in u)k.event.remove(e,d+t[l],n,r,!0);k.isEmptyObject(u)&&Q.remove(e,"handle events")}},dispatch:function(e){var t,n,r,i,o,a,s=k.event.fix(e),u=new Array(arguments.length),l=(Q.get(this,"events")||{})[s.type]||[],c=k.event.special[s.type]||{};for(u[0]=s,t=1;t\x20\t\r\n\f]*)[^>]*)\/>/gi,qe=/\s*$/g;function Oe(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&k(e).children("tbody")[0]||e}function Pe(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function Re(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Me(e,t){var n,r,i,o,a,s,u,l;if(1===t.nodeType){if(Q.hasData(e)&&(o=Q.access(e),a=Q.set(t,o),l=o.events))for(i in delete a.handle,a.events={},l)for(n=0,r=l[i].length;n")},clone:function(e,t,n){var r,i,o,a,s,u,l,c=e.cloneNode(!0),f=oe(e);if(!(y.noCloneChecked||1!==e.nodeType&&11!==e.nodeType||k.isXMLDoc(e)))for(a=ve(c),r=0,i=(o=ve(e)).length;r").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Vt,Gt=[],Yt=/(=)\?(?=&|$)|\?\?/;k.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Gt.pop()||k.expando+"_"+kt++;return this[e]=!0,e}}),k.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Yt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Yt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Yt,"$1"+r):!1!==e.jsonp&&(e.url+=(St.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||k.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?k(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Gt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((Vt=E.implementation.createHTMLDocument("").body).innerHTML="
",2===Vt.childNodes.length),k.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=D.exec(e))?[t.createElement(i[1])]:(i=we([e],t,o),o&&o.length&&k(o).remove(),k.merge([],i.childNodes)));var r,i,o},k.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(k.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},k.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){k.fn[t]=function(e){return this.on(t,e)}}),k.expr.pseudos.animated=function(t){return k.grep(k.timers,function(e){return t===e.elem}).length},k.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=k.css(e,"position"),c=k(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=k.css(e,"top"),u=k.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,k.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},k.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){k.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===k.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===k.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=k(e).offset()).top+=k.css(e,"borderTopWidth",!0),i.left+=k.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-k.css(r,"marginTop",!0),left:t.left-i.left-k.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===k.css(e,"position"))e=e.offsetParent;return e||ie})}}),k.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;k.fn[t]=function(e){return _(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),k.each(["top","left"],function(e,n){k.cssHooks[n]=ze(y.pixelPosition,function(e,t){if(t)return t=_e(e,n),$e.test(t)?k(e).position()[n]+"px":t})}),k.each({Height:"height",Width:"width"},function(a,s){k.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){k.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return _(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?k.css(e,t,i):k.style(e,t,n,i)},s,n?e:void 0,n)}})}),k.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){k.fn[n]=function(e,t){return 0=this.length)return z.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},z.QueryLexer.prototype.width=function(){return this.pos-this.start},z.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},z.QueryLexer.prototype.backup=function(){this.pos-=1},z.QueryLexer.prototype.acceptDigitRun=function(){for(var e,t;47<(t=(e=this.next()).charCodeAt(0))&&t<58;);e!=z.QueryLexer.EOS&&this.backup()},z.QueryLexer.prototype.more=function(){return this.pos', - menu: '
' - }; - } - function buildSelectors(classes) { - var selectors = {}; - _.each(classes, function(v, k) { - selectors[k] = "." + v; - }); - return selectors; - } - function buildCss() { - var css = { - wrapper: { - position: "relative", - display: "inline-block" - }, - hint: { - position: "absolute", - top: "0", - left: "0", - borderColor: "transparent", - boxShadow: "none", - opacity: "1" - }, - input: { - position: "relative", - verticalAlign: "top", - backgroundColor: "transparent" - }, - inputWithNoHint: { - position: "relative", - verticalAlign: "top" - }, - menu: { - position: "absolute", - top: "100%", - left: "0", - zIndex: "100", - display: "none" - }, - ltr: { - left: "0", - right: "auto" - }, - rtl: { - left: "auto", - right: " 0" - } - }; - if (_.isMsie()) { - _.mixin(css.input, { - backgroundImage: "url(data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)" - }); - } - return css; - } - }(); - var EventBus = function() { - "use strict"; - var namespace, deprecationMap; - namespace = "typeahead:"; - deprecationMap = { - render: "rendered", - cursorchange: "cursorchanged", - select: "selected", - autocomplete: "autocompleted" - }; - function EventBus(o) { - if (!o || !o.el) { - $.error("EventBus initialized without el"); - } - this.$el = $(o.el); - } - _.mixin(EventBus.prototype, { - _trigger: function(type, args) { - var $e = $.Event(namespace + type); - this.$el.trigger.call(this.$el, $e, args || []); - return $e; - }, - before: function(type) { - var args, $e; - args = [].slice.call(arguments, 1); - $e = this._trigger("before" + type, args); - return $e.isDefaultPrevented(); - }, - trigger: function(type) { - var deprecatedType; - this._trigger(type, [].slice.call(arguments, 1)); - if (deprecatedType = deprecationMap[type]) { - this._trigger(deprecatedType, [].slice.call(arguments, 1)); - } - } - }); - return EventBus; - }(); - var EventEmitter = function() { - "use strict"; - var splitter = /\s+/, nextTick = getNextTick(); - return { - onSync: onSync, - onAsync: onAsync, - off: off, - trigger: trigger - }; - function on(method, types, cb, context) { - var type; - if (!cb) { - return this; - } - types = types.split(splitter); - cb = context ? bindContext(cb, context) : cb; - this._callbacks = this._callbacks || {}; - while (type = types.shift()) { - this._callbacks[type] = this._callbacks[type] || { - sync: [], - async: [] - }; - this._callbacks[type][method].push(cb); - } - return this; - } - function onAsync(types, cb, context) { - return on.call(this, "async", types, cb, context); - } - function onSync(types, cb, context) { - return on.call(this, "sync", types, cb, context); - } - function off(types) { - var type; - if (!this._callbacks) { - return this; - } - types = types.split(splitter); - while (type = types.shift()) { - delete this._callbacks[type]; - } - return this; - } - function trigger(types) { - var type, callbacks, args, syncFlush, asyncFlush; - if (!this._callbacks) { - return this; - } - types = types.split(splitter); - args = [].slice.call(arguments, 1); - while ((type = types.shift()) && (callbacks = this._callbacks[type])) { - syncFlush = getFlush(callbacks.sync, this, [ type ].concat(args)); - asyncFlush = getFlush(callbacks.async, this, [ type ].concat(args)); - syncFlush() && nextTick(asyncFlush); - } - return this; - } - function getFlush(callbacks, context, args) { - return flush; - function flush() { - var cancelled; - for (var i = 0, len = callbacks.length; !cancelled && i < len; i += 1) { - cancelled = callbacks[i].apply(context, args) === false; - } - return !cancelled; - } - } - function getNextTick() { - var nextTickFn; - if (window.setImmediate) { - nextTickFn = function nextTickSetImmediate(fn) { - setImmediate(function() { - fn(); - }); - }; - } else { - nextTickFn = function nextTickSetTimeout(fn) { - setTimeout(function() { - fn(); - }, 0); - }; - } - return nextTickFn; - } - function bindContext(fn, context) { - return fn.bind ? fn.bind(context) : function() { - fn.apply(context, [].slice.call(arguments, 0)); - }; - } - }(); - var highlight = function(doc) { - "use strict"; - var defaults = { - node: null, - pattern: null, - tagName: "strong", - className: null, - wordsOnly: false, - caseSensitive: false, - diacriticInsensitive: false - }; - var accented = { - A: "[AaªÀ-Åà-åĀ-ąǍǎȀ-ȃȦȧᴬᵃḀḁẚẠ-ảₐ℀℁℻⒜Ⓐⓐ㍱-㍴㎀-㎄㎈㎉㎩-㎯㏂㏊㏟㏿Ａａ]", - B: "[BbᴮᵇḂ-ḇℬ⒝Ⓑⓑ㍴㎅-㎇㏃㏈㏔㏝Ｂｂ]", - C: "[CcÇçĆ-čᶜ℀ℂ℃℅℆ℭⅭⅽ⒞Ⓒⓒ㍶㎈㎉㎝㎠㎤㏄-㏇Ｃｃ]", - D: "[DdĎďDŽ-džDZ-dzᴰᵈḊ-ḓⅅⅆⅮⅾ⒟Ⓓⓓ㋏㍲㍷-㍹㎗㎭-㎯㏅㏈Ｄｄ]", - E: "[EeÈ-Ëè-ëĒ-ěȄ-ȇȨȩᴱᵉḘ-ḛẸ-ẽₑ℡ℯℰⅇ⒠Ⓔⓔ㉐㋍㋎Ｅｅ]", - F: "[FfᶠḞḟ℉ℱ℻⒡Ⓕⓕ㎊-㎌㎙ff-fflＦｆ]", - G: "[GgĜ-ģǦǧǴǵᴳᵍḠḡℊ⒢Ⓖⓖ㋌㋍㎇㎍-㎏㎓㎬㏆㏉㏒㏿Ｇｇ]", - H: "[HhĤĥȞȟʰᴴḢ-ḫẖℋ-ℎ⒣Ⓗⓗ㋌㍱㎐-㎔㏊㏋㏗Ｈｈ]", - I: "[IiÌ-Ïì-ïĨ-İIJijǏǐȈ-ȋᴵᵢḬḭỈ-ịⁱℐℑℹⅈⅠ-ⅣⅥ-ⅨⅪⅫⅰ-ⅳⅵ-ⅸⅺⅻ⒤Ⓘⓘ㍺㏌㏕fiffiＩｉ]", - J: "[JjIJ-ĵLJ-njǰʲᴶⅉ⒥ⒿⓙⱼＪｊ]", - K: "[KkĶķǨǩᴷᵏḰ-ḵK⒦Ⓚⓚ㎄㎅㎉㎏㎑㎘㎞㎢㎦㎪㎸㎾㏀㏆㏍-㏏Ｋｋ]", - L: "[LlĹ-ŀLJ-ljˡᴸḶḷḺ-ḽℒℓ℡Ⅼⅼ⒧Ⓛⓛ㋏㎈㎉㏐-㏓㏕㏖㏿flfflＬｌ]", - M: "[MmᴹᵐḾ-ṃ℠™ℳⅯⅿ⒨Ⓜⓜ㍷-㍹㎃㎆㎎㎒㎖㎙-㎨㎫㎳㎷㎹㎽㎿㏁㏂㏎㏐㏔-㏖㏘㏙㏞㏟Ｍｍ]", - N: "[NnÑñŃ-ʼnNJ-njǸǹᴺṄ-ṋⁿℕ№⒩Ⓝⓝ㎁㎋㎚㎱㎵㎻㏌㏑Ｎｎ]", - O: "[OoºÒ-Öò-öŌ-őƠơǑǒǪǫȌ-ȏȮȯᴼᵒỌ-ỏₒ℅№ℴ⒪Ⓞⓞ㍵㏇㏒㏖Ｏｏ]", - P: "[PpᴾᵖṔ-ṗℙ⒫Ⓟⓟ㉐㍱㍶㎀㎊㎩-㎬㎰㎴㎺㏋㏗-㏚Ｐｐ]", - Q: "[Qqℚ⒬Ⓠⓠ㏃Ｑｑ]", - R: "[RrŔ-řȐ-ȓʳᴿᵣṘ-ṛṞṟ₨ℛ-ℝ⒭Ⓡⓡ㋍㍴㎭-㎯㏚㏛Ｒｒ]", - S: "[SsŚ-šſȘșˢṠ-ṣ₨℁℠⒮Ⓢⓢ㎧㎨㎮-㎳㏛㏜stＳｓ]", - T: "[TtŢ-ťȚțᵀᵗṪ-ṱẗ℡™⒯Ⓣⓣ㉐㋏㎔㏏ſtstＴｔ]", - U: "[UuÙ-Üù-üŨ-ųƯưǓǔȔ-ȗᵁᵘᵤṲ-ṷỤ-ủ℆⒰Ⓤⓤ㍳㍺Ｕｕ]", - V: "[VvᵛᵥṼ-ṿⅣ-Ⅷⅳ-ⅷ⒱Ⓥⓥⱽ㋎㍵㎴-㎹㏜㏞Ｖｖ]", - W: "[WwŴŵʷᵂẀ-ẉẘ⒲Ⓦⓦ㎺-㎿㏝Ｗｗ]", - X: "[XxˣẊ-ẍₓ℻Ⅸ-Ⅻⅸ-ⅻ⒳Ⓧⓧ㏓Ｘｘ]", - Y: "[YyÝýÿŶ-ŸȲȳʸẎẏẙỲ-ỹ⒴Ⓨⓨ㏉Ｙｙ]", - Z: "[ZzŹ-žDZ-dzᶻẐ-ẕℤℨ⒵Ⓩⓩ㎐-㎔Ｚｚ]" - }; - return function hightlight(o) { - var regex; - o = _.mixin({}, defaults, o); - if (!o.node || !o.pattern) { - return; - } - o.pattern = _.isArray(o.pattern) ? o.pattern : [ o.pattern ]; - regex = getRegex(o.pattern, o.caseSensitive, o.wordsOnly, o.diacriticInsensitive); - traverse(o.node, hightlightTextNode); - function hightlightTextNode(textNode) { - var match, patternNode, wrapperNode; - if (match = regex.exec(textNode.data)) { - wrapperNode = doc.createElement(o.tagName); - o.className && (wrapperNode.className = o.className); - patternNode = textNode.splitText(match.index); - patternNode.splitText(match[0].length); - wrapperNode.appendChild(patternNode.cloneNode(true)); - textNode.parentNode.replaceChild(wrapperNode, patternNode); - } - return !!match; - } - function traverse(el, hightlightTextNode) { - var childNode, TEXT_NODE_TYPE = 3; - for (var i = 0; i < el.childNodes.length; i++) { - childNode = el.childNodes[i]; - if (childNode.nodeType === TEXT_NODE_TYPE) { - i += hightlightTextNode(childNode) ? 1 : 0; - } else { - traverse(childNode, hightlightTextNode); - } - } - } - }; - function accent_replacer(chr) { - return accented[chr.toUpperCase()] || chr; - } - function getRegex(patterns, caseSensitive, wordsOnly, diacriticInsensitive) { - var escapedPatterns = [], regexStr; - for (var i = 0, len = patterns.length; i < len; i++) { - var escapedWord = _.escapeRegExChars(patterns[i]); - if (diacriticInsensitive) { - escapedWord = escapedWord.replace(/\S/g, accent_replacer); - } - escapedPatterns.push(escapedWord); - } - regexStr = wordsOnly ? "\\b(" + escapedPatterns.join("|") + ")\\b" : "(" + escapedPatterns.join("|") + ")"; - return caseSensitive ? new RegExp(regexStr) : new RegExp(regexStr, "i"); - } - }(window.document); - var Input = function() { - "use strict"; - var specialKeyCodeMap; - specialKeyCodeMap = { - 9: "tab", - 27: "esc", - 37: "left", - 39: "right", - 13: "enter", - 38: "up", - 40: "down" - }; - function Input(o, www) { - o = o || {}; - if (!o.input) { - $.error("input is missing"); - } - www.mixin(this); - this.$hint = $(o.hint); - this.$input = $(o.input); - this.$input.attr({ - "aria-activedescendant": "", - "aria-owns": this.$input.attr("id") + "_listbox", - role: "combobox", - "aria-readonly": "true", - "aria-autocomplete": "list" - }); - $(www.menu).attr("id", this.$input.attr("id") + "_listbox"); - this.query = this.$input.val(); - this.queryWhenFocused = this.hasFocus() ? this.query : null; - this.$overflowHelper = buildOverflowHelper(this.$input); - this._checkLanguageDirection(); - if (this.$hint.length === 0) { - this.setHint = this.getHint = this.clearHint = this.clearHintIfInvalid = _.noop; - } - this.onSync("cursorchange", this._updateDescendent); - } - Input.normalizeQuery = function(str) { - return _.toStr(str).replace(/^\s*/g, "").replace(/\s{2,}/g, " "); - }; - _.mixin(Input.prototype, EventEmitter, { - _onBlur: function onBlur() { - this.resetInputValue(); - this.trigger("blurred"); - }, - _onFocus: function onFocus() { - this.queryWhenFocused = this.query; - this.trigger("focused"); - }, - _onKeydown: function onKeydown($e) { - var keyName = specialKeyCodeMap[$e.which || $e.keyCode]; - this._managePreventDefault(keyName, $e); - if (keyName && this._shouldTrigger(keyName, $e)) { - this.trigger(keyName + "Keyed", $e); - } - }, - _onInput: function onInput() { - this._setQuery(this.getInputValue()); - this.clearHintIfInvalid(); - this._checkLanguageDirection(); - }, - _managePreventDefault: function managePreventDefault(keyName, $e) { - var preventDefault; - switch (keyName) { - case "up": - case "down": - preventDefault = !withModifier($e); - break; - - default: - preventDefault = false; - } - preventDefault && $e.preventDefault(); - }, - _shouldTrigger: function shouldTrigger(keyName, $e) { - var trigger; - switch (keyName) { - case "tab": - trigger = !withModifier($e); - break; - - default: - trigger = true; - } - return trigger; - }, - _checkLanguageDirection: function checkLanguageDirection() { - var dir = (this.$input.css("direction") || "ltr").toLowerCase(); - if (this.dir !== dir) { - this.dir = dir; - this.$hint.attr("dir", dir); - this.trigger("langDirChanged", dir); - } - }, - _setQuery: function setQuery(val, silent) { - var areEquivalent, hasDifferentWhitespace; - areEquivalent = areQueriesEquivalent(val, this.query); - hasDifferentWhitespace = areEquivalent ? this.query.length !== val.length : false; - this.query = val; - if (!silent && !areEquivalent) { - this.trigger("queryChanged", this.query); - } else if (!silent && hasDifferentWhitespace) { - this.trigger("whitespaceChanged", this.query); - } - }, - _updateDescendent: function updateDescendent(event, id) { - this.$input.attr("aria-activedescendant", id); - }, - bind: function() { - var that = this, onBlur, onFocus, onKeydown, onInput; - onBlur = _.bind(this._onBlur, this); - onFocus = _.bind(this._onFocus, this); - onKeydown = _.bind(this._onKeydown, this); - onInput = _.bind(this._onInput, this); - this.$input.on("blur.tt", onBlur).on("focus.tt", onFocus).on("keydown.tt", onKeydown); - if (!_.isMsie() || _.isMsie() > 9) { - this.$input.on("input.tt", onInput); - } else { - this.$input.on("keydown.tt keypress.tt cut.tt paste.tt", function($e) { - if (specialKeyCodeMap[$e.which || $e.keyCode]) { - return; - } - _.defer(_.bind(that._onInput, that, $e)); - }); - } - return this; - }, - focus: function focus() { - this.$input.focus(); - }, - blur: function blur() { - this.$input.blur(); - }, - getLangDir: function getLangDir() { - return this.dir; - }, - getQuery: function getQuery() { - return this.query || ""; - }, - setQuery: function setQuery(val, silent) { - this.setInputValue(val); - this._setQuery(val, silent); - }, - hasQueryChangedSinceLastFocus: function hasQueryChangedSinceLastFocus() { - return this.query !== this.queryWhenFocused; - }, - getInputValue: function getInputValue() { - return this.$input.val(); - }, - setInputValue: function setInputValue(value) { - this.$input.val(value); - this.clearHintIfInvalid(); - this._checkLanguageDirection(); - }, - resetInputValue: function resetInputValue() { - this.setInputValue(this.query); - }, - getHint: function getHint() { - return this.$hint.val(); - }, - setHint: function setHint(value) { - this.$hint.val(value); - }, - clearHint: function clearHint() { - this.setHint(""); - }, - clearHintIfInvalid: function clearHintIfInvalid() { - var val, hint, valIsPrefixOfHint, isValid; - val = this.getInputValue(); - hint = this.getHint(); - valIsPrefixOfHint = val !== hint && hint.indexOf(val) === 0; - isValid = val !== "" && valIsPrefixOfHint && !this.hasOverflow(); - !isValid && this.clearHint(); - }, - hasFocus: function hasFocus() { - return this.$input.is(":focus"); - }, - hasOverflow: function hasOverflow() { - var constraint = this.$input.width() - 2; - this.$overflowHelper.text(this.getInputValue()); - return this.$overflowHelper.width() >= constraint; - }, - isCursorAtEnd: function() { - var valueLength, selectionStart, range; - valueLength = this.$input.val().length; - selectionStart = this.$input[0].selectionStart; - if (_.isNumber(selectionStart)) { - return selectionStart === valueLength; - } else if (document.selection) { - range = document.selection.createRange(); - range.moveStart("character", -valueLength); - return valueLength === range.text.length; - } - return true; - }, - destroy: function destroy() { - this.$hint.off(".tt"); - this.$input.off(".tt"); - this.$overflowHelper.remove(); - this.$hint = this.$input = this.$overflowHelper = $("
"); - } - }); - return Input; - function buildOverflowHelper($input) { - return $('').css({ - position: "absolute", - visibility: "hidden", - whiteSpace: "pre", - fontFamily: $input.css("font-family"), - fontSize: $input.css("font-size"), - fontStyle: $input.css("font-style"), - fontVariant: $input.css("font-variant"), - fontWeight: $input.css("font-weight"), - wordSpacing: $input.css("word-spacing"), - letterSpacing: $input.css("letter-spacing"), - textIndent: $input.css("text-indent"), - textRendering: $input.css("text-rendering"), - textTransform: $input.css("text-transform") - }).insertAfter($input); - } - function areQueriesEquivalent(a, b) { - return Input.normalizeQuery(a) === Input.normalizeQuery(b); - } - function withModifier($e) { - return $e.altKey || $e.ctrlKey || $e.metaKey || $e.shiftKey; - } - }(); - var Dataset = function() { - "use strict"; - var keys, nameGenerator; - keys = { - dataset: "tt-selectable-dataset", - val: "tt-selectable-display", - obj: "tt-selectable-object" - }; - nameGenerator = _.getIdGenerator(); - function Dataset(o, www) { - o = o || {}; - o.templates = o.templates || {}; - o.templates.notFound = o.templates.notFound || o.templates.empty; - if (!o.source) { - $.error("missing source"); - } - if (!o.node) { - $.error("missing node"); - } - if (o.name && !isValidName(o.name)) { - $.error("invalid dataset name: " + o.name); - } - www.mixin(this); - this.highlight = !!o.highlight; - this.name = _.toStr(o.name || nameGenerator()); - this.limit = o.limit || 5; - this.displayFn = getDisplayFn(o.display || o.displayKey); - this.templates = getTemplates(o.templates, this.displayFn); - this.source = o.source.__ttAdapter ? o.source.__ttAdapter() : o.source; - this.async = _.isUndefined(o.async) ? this.source.length > 2 : !!o.async; - this._resetLastSuggestion(); - this.$el = $(o.node).attr("role", "presentation").addClass(this.classes.dataset).addClass(this.classes.dataset + "-" + this.name); - } - Dataset.extractData = function extractData(el) { - var $el = $(el); - if ($el.data(keys.obj)) { - return { - dataset: $el.data(keys.dataset) || "", - val: $el.data(keys.val) || "", - obj: $el.data(keys.obj) || null - }; - } - return null; - }; - _.mixin(Dataset.prototype, EventEmitter, { - _overwrite: function overwrite(query, suggestions) { - suggestions = suggestions || []; - if (suggestions.length) { - this._renderSuggestions(query, suggestions); - } else if (this.async && this.templates.pending) { - this._renderPending(query); - } else if (!this.async && this.templates.notFound) { - this._renderNotFound(query); - } else { - this._empty(); - } - this.trigger("rendered", suggestions, false, this.name); - }, - _append: function append(query, suggestions) { - suggestions = suggestions || []; - if (suggestions.length && this.$lastSuggestion.length) { - this._appendSuggestions(query, suggestions); - } else if (suggestions.length) { - this._renderSuggestions(query, suggestions); - } else if (!this.$lastSuggestion.length && this.templates.notFound) { - this._renderNotFound(query); - } - this.trigger("rendered", suggestions, true, this.name); - }, - _renderSuggestions: function renderSuggestions(query, suggestions) { - var $fragment; - $fragment = this._getSuggestionsFragment(query, suggestions); - this.$lastSuggestion = $fragment.children().last(); - this.$el.html($fragment).prepend(this._getHeader(query, suggestions)).append(this._getFooter(query, suggestions)); - }, - _appendSuggestions: function appendSuggestions(query, suggestions) { - var $fragment, $lastSuggestion; - $fragment = this._getSuggestionsFragment(query, suggestions); - $lastSuggestion = $fragment.children().last(); - this.$lastSuggestion.after($fragment); - this.$lastSuggestion = $lastSuggestion; - }, - _renderPending: function renderPending(query) { - var template = this.templates.pending; - this._resetLastSuggestion(); - template && this.$el.html(template({ - query: query, - dataset: this.name - })); - }, - _renderNotFound: function renderNotFound(query) { - var template = this.templates.notFound; - this._resetLastSuggestion(); - template && this.$el.html(template({ - query: query, - dataset: this.name - })); - }, - _empty: function empty() { - this.$el.empty(); - this._resetLastSuggestion(); - }, - _getSuggestionsFragment: function getSuggestionsFragment(query, suggestions) { - var that = this, fragment; - fragment = document.createDocumentFragment(); - _.each(suggestions, function getSuggestionNode(suggestion) { - var $el, context; - context = that._injectQuery(query, suggestion); - $el = $(that.templates.suggestion(context)).data(keys.dataset, that.name).data(keys.obj, suggestion).data(keys.val, that.displayFn(suggestion)).addClass(that.classes.suggestion + " " + that.classes.selectable); - fragment.appendChild($el[0]); - }); - this.highlight && highlight({ - className: this.classes.highlight, - node: fragment, - pattern: query - }); - return $(fragment); - }, - _getFooter: function getFooter(query, suggestions) { - return this.templates.footer ? this.templates.footer({ - query: query, - suggestions: suggestions, - dataset: this.name - }) : null; - }, - _getHeader: function getHeader(query, suggestions) { - return this.templates.header ? this.templates.header({ - query: query, - suggestions: suggestions, - dataset: this.name - }) : null; - }, - _resetLastSuggestion: function resetLastSuggestion() { - this.$lastSuggestion = $(); - }, - _injectQuery: function injectQuery(query, obj) { - return _.isObject(obj) ? _.mixin({ - _query: query - }, obj) : obj; - }, - update: function update(query) { - var that = this, canceled = false, syncCalled = false, rendered = 0; - this.cancel(); - this.cancel = function cancel() { - canceled = true; - that.cancel = $.noop; - that.async && that.trigger("asyncCanceled", query, that.name); - }; - this.source(query, sync, async); - !syncCalled && sync([]); - function sync(suggestions) { - if (syncCalled) { - return; - } - syncCalled = true; - suggestions = (suggestions || []).slice(0, that.limit); - rendered = suggestions.length; - that._overwrite(query, suggestions); - if (rendered < that.limit && that.async) { - that.trigger("asyncRequested", query, that.name); - } - } - function async(suggestions) { - suggestions = suggestions || []; - if (!canceled && rendered < that.limit) { - that.cancel = $.noop; - var idx = Math.abs(rendered - that.limit); - rendered += idx; - that._append(query, suggestions.slice(0, idx)); - that.async && that.trigger("asyncReceived", query, that.name); - } - } - }, - cancel: $.noop, - clear: function clear() { - this._empty(); - this.cancel(); - this.trigger("cleared"); - }, - isEmpty: function isEmpty() { - return this.$el.is(":empty"); - }, - destroy: function destroy() { - this.$el = $("
"); - } - }); - return Dataset; - function getDisplayFn(display) { - display = display || _.stringify; - return _.isFunction(display) ? display : displayFn; - function displayFn(obj) { - return obj[display]; - } - } - function getTemplates(templates, displayFn) { - return { - notFound: templates.notFound && _.templatify(templates.notFound), - pending: templates.pending && _.templatify(templates.pending), - header: templates.header && _.templatify(templates.header), - footer: templates.footer && _.templatify(templates.footer), - suggestion: templates.suggestion || suggestionTemplate - }; - function suggestionTemplate(context) { - return $('
').attr("id", _.guid()).text(displayFn(context)); - } - } - function isValidName(str) { - return /^[_a-zA-Z0-9-]+$/.test(str); - } - }(); - var Menu = function() { - "use strict"; - function Menu(o, www) { - var that = this; - o = o || {}; - if (!o.node) { - $.error("node is required"); - } - www.mixin(this); - this.$node = $(o.node); - this.query = null; - this.datasets = _.map(o.datasets, initializeDataset); - function initializeDataset(oDataset) { - var node = that.$node.find(oDataset.node).first(); - oDataset.node = node.length ? node : $("
").appendTo(that.$node); - return new Dataset(oDataset, www); - } - } - _.mixin(Menu.prototype, EventEmitter, { - _onSelectableClick: function onSelectableClick($e) { - this.trigger("selectableClicked", $($e.currentTarget)); - }, - _onRendered: function onRendered(type, dataset, suggestions, async) { - this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty()); - this.trigger("datasetRendered", dataset, suggestions, async); - }, - _onCleared: function onCleared() { - this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty()); - this.trigger("datasetCleared"); - }, - _propagate: function propagate() { - this.trigger.apply(this, arguments); - }, - _allDatasetsEmpty: function allDatasetsEmpty() { - return _.every(this.datasets, _.bind(function isDatasetEmpty(dataset) { - var isEmpty = dataset.isEmpty(); - this.$node.attr("aria-expanded", !isEmpty); - return isEmpty; - }, this)); - }, - _getSelectables: function getSelectables() { - return this.$node.find(this.selectors.selectable); - }, - _removeCursor: function _removeCursor() { - var $selectable = this.getActiveSelectable(); - $selectable && $selectable.removeClass(this.classes.cursor); - }, - _ensureVisible: function ensureVisible($el) { - var elTop, elBottom, nodeScrollTop, nodeHeight; - elTop = $el.position().top; - elBottom = elTop + $el.outerHeight(true); - nodeScrollTop = this.$node.scrollTop(); - nodeHeight = this.$node.height() + parseInt(this.$node.css("paddingTop"), 10) + parseInt(this.$node.css("paddingBottom"), 10); - if (elTop < 0) { - this.$node.scrollTop(nodeScrollTop + elTop); - } else if (nodeHeight < elBottom) { - this.$node.scrollTop(nodeScrollTop + (elBottom - nodeHeight)); - } - }, - bind: function() { - var that = this, onSelectableClick; - onSelectableClick = _.bind(this._onSelectableClick, this); - this.$node.on("click.tt", this.selectors.selectable, onSelectableClick); - this.$node.on("mouseover", this.selectors.selectable, function() { - that.setCursor($(this)); - }); - this.$node.on("mouseleave", function() { - that._removeCursor(); - }); - _.each(this.datasets, function(dataset) { - dataset.onSync("asyncRequested", that._propagate, that).onSync("asyncCanceled", that._propagate, that).onSync("asyncReceived", that._propagate, that).onSync("rendered", that._onRendered, that).onSync("cleared", that._onCleared, that); - }); - return this; - }, - isOpen: function isOpen() { - return this.$node.hasClass(this.classes.open); - }, - open: function open() { - this.$node.scrollTop(0); - this.$node.addClass(this.classes.open); - }, - close: function close() { - this.$node.attr("aria-expanded", false); - this.$node.removeClass(this.classes.open); - this._removeCursor(); - }, - setLanguageDirection: function setLanguageDirection(dir) { - this.$node.attr("dir", dir); - }, - selectableRelativeToCursor: function selectableRelativeToCursor(delta) { - var $selectables, $oldCursor, oldIndex, newIndex; - $oldCursor = this.getActiveSelectable(); - $selectables = this._getSelectables(); - oldIndex = $oldCursor ? $selectables.index($oldCursor) : -1; - newIndex = oldIndex + delta; - newIndex = (newIndex + 1) % ($selectables.length + 1) - 1; - newIndex = newIndex < -1 ? $selectables.length - 1 : newIndex; - return newIndex === -1 ? null : $selectables.eq(newIndex); - }, - setCursor: function setCursor($selectable) { - this._removeCursor(); - if ($selectable = $selectable && $selectable.first()) { - $selectable.addClass(this.classes.cursor); - this._ensureVisible($selectable); - } - }, - getSelectableData: function getSelectableData($el) { - return $el && $el.length ? Dataset.extractData($el) : null; - }, - getActiveSelectable: function getActiveSelectable() { - var $selectable = this._getSelectables().filter(this.selectors.cursor).first(); - return $selectable.length ? $selectable : null; - }, - getTopSelectable: function getTopSelectable() { - var $selectable = this._getSelectables().first(); - return $selectable.length ? $selectable : null; - }, - update: function update(query) { - var isValidUpdate = query !== this.query; - if (isValidUpdate) { - this.query = query; - _.each(this.datasets, updateDataset); - } - return isValidUpdate; - function updateDataset(dataset) { - dataset.update(query); - } - }, - empty: function empty() { - _.each(this.datasets, clearDataset); - this.query = null; - this.$node.addClass(this.classes.empty); - function clearDataset(dataset) { - dataset.clear(); - } - }, - destroy: function destroy() { - this.$node.off(".tt"); - this.$node = $("
"); - _.each(this.datasets, destroyDataset); - function destroyDataset(dataset) { - dataset.destroy(); - } - } - }); - return Menu; - }(); - var Status = function() { - "use strict"; - function Status(options) { - this.$el = $("", { - role: "status", - "aria-live": "polite" - }).css({ - position: "absolute", - padding: "0", - border: "0", - height: "1px", - width: "1px", - "margin-bottom": "-1px", - "margin-right": "-1px", - overflow: "hidden", - clip: "rect(0 0 0 0)", - "white-space": "nowrap" - }); - options.$input.after(this.$el); - _.each(options.menu.datasets, _.bind(function(dataset) { - if (dataset.onSync) { - dataset.onSync("rendered", _.bind(this.update, this)); - dataset.onSync("cleared", _.bind(this.cleared, this)); - } - }, this)); - } - _.mixin(Status.prototype, { - update: function update(event, suggestions) { - var length = suggestions.length; - var words; - if (length === 1) { - words = { - result: "result", - is: "is" - }; - } else { - words = { - result: "results", - is: "are" - }; - } - this.$el.text(length + " " + words.result + " " + words.is + " available, use up and down arrow keys to navigate."); - }, - cleared: function() { - this.$el.text(""); - } - }); - return Status; - }(); - var DefaultMenu = function() { - "use strict"; - var s = Menu.prototype; - function DefaultMenu() { - Menu.apply(this, [].slice.call(arguments, 0)); - } - _.mixin(DefaultMenu.prototype, Menu.prototype, { - open: function open() { - !this._allDatasetsEmpty() && this._show(); - return s.open.apply(this, [].slice.call(arguments, 0)); - }, - close: function close() { - this._hide(); - return s.close.apply(this, [].slice.call(arguments, 0)); - }, - _onRendered: function onRendered() { - if (this._allDatasetsEmpty()) { - this._hide(); - } else { - this.isOpen() && this._show(); - } - return s._onRendered.apply(this, [].slice.call(arguments, 0)); - }, - _onCleared: function onCleared() { - if (this._allDatasetsEmpty()) { - this._hide(); - } else { - this.isOpen() && this._show(); - } - return s._onCleared.apply(this, [].slice.call(arguments, 0)); - }, - setLanguageDirection: function setLanguageDirection(dir) { - this.$node.css(dir === "ltr" ? this.css.ltr : this.css.rtl); - return s.setLanguageDirection.apply(this, [].slice.call(arguments, 0)); - }, - _hide: function hide() { - this.$node.hide(); - }, - _show: function show() { - this.$node.css("display", "block"); - } - }); - return DefaultMenu; - }(); - var Typeahead = function() { - "use strict"; - function Typeahead(o, www) { - var onFocused, onBlurred, onEnterKeyed, onTabKeyed, onEscKeyed, onUpKeyed, onDownKeyed, onLeftKeyed, onRightKeyed, onQueryChanged, onWhitespaceChanged; - o = o || {}; - if (!o.input) { - $.error("missing input"); - } - if (!o.menu) { - $.error("missing menu"); - } - if (!o.eventBus) { - $.error("missing event bus"); - } - www.mixin(this); - this.eventBus = o.eventBus; - this.minLength = _.isNumber(o.minLength) ? o.minLength : 1; - this.input = o.input; - this.menu = o.menu; - this.enabled = true; - this.autoselect = !!o.autoselect; - this.active = false; - this.input.hasFocus() && this.activate(); - this.dir = this.input.getLangDir(); - this._hacks(); - this.menu.bind().onSync("selectableClicked", this._onSelectableClicked, this).onSync("asyncRequested", this._onAsyncRequested, this).onSync("asyncCanceled", this._onAsyncCanceled, this).onSync("asyncReceived", this._onAsyncReceived, this).onSync("datasetRendered", this._onDatasetRendered, this).onSync("datasetCleared", this._onDatasetCleared, this); - onFocused = c(this, "activate", "open", "_onFocused"); - onBlurred = c(this, "deactivate", "_onBlurred"); - onEnterKeyed = c(this, "isActive", "isOpen", "_onEnterKeyed"); - onTabKeyed = c(this, "isActive", "isOpen", "_onTabKeyed"); - onEscKeyed = c(this, "isActive", "_onEscKeyed"); - onUpKeyed = c(this, "isActive", "open", "_onUpKeyed"); - onDownKeyed = c(this, "isActive", "open", "_onDownKeyed"); - onLeftKeyed = c(this, "isActive", "isOpen", "_onLeftKeyed"); - onRightKeyed = c(this, "isActive", "isOpen", "_onRightKeyed"); - onQueryChanged = c(this, "_openIfActive", "_onQueryChanged"); - onWhitespaceChanged = c(this, "_openIfActive", "_onWhitespaceChanged"); - this.input.bind().onSync("focused", onFocused, this).onSync("blurred", onBlurred, this).onSync("enterKeyed", onEnterKeyed, this).onSync("tabKeyed", onTabKeyed, this).onSync("escKeyed", onEscKeyed, this).onSync("upKeyed", onUpKeyed, this).onSync("downKeyed", onDownKeyed, this).onSync("leftKeyed", onLeftKeyed, this).onSync("rightKeyed", onRightKeyed, this).onSync("queryChanged", onQueryChanged, this).onSync("whitespaceChanged", onWhitespaceChanged, this).onSync("langDirChanged", this._onLangDirChanged, this); - } - _.mixin(Typeahead.prototype, { - _hacks: function hacks() { - var $input, $menu; - $input = this.input.$input || $("
"); - $menu = this.menu.$node || $("
"); - $input.on("blur.tt", function($e) { - var active, isActive, hasActive; - active = document.activeElement; - isActive = $menu.is(active); - hasActive = $menu.has(active).length > 0; - if (_.isMsie() && (isActive || hasActive)) { - $e.preventDefault(); - $e.stopImmediatePropagation(); - _.defer(function() { - $input.focus(); - }); - } - }); - $menu.on("mousedown.tt", function($e) { - $e.preventDefault(); - }); - }, - _onSelectableClicked: function onSelectableClicked(type, $el) { - this.select($el); - }, - _onDatasetCleared: function onDatasetCleared() { - this._updateHint(); - }, - _onDatasetRendered: function onDatasetRendered(type, suggestions, async, dataset) { - this._updateHint(); - if (this.autoselect) { - var cursorClass = this.selectors.cursor.substr(1); - this.menu.$node.find(this.selectors.suggestion).first().addClass(cursorClass); - } - this.eventBus.trigger("render", suggestions, async, dataset); - }, - _onAsyncRequested: function onAsyncRequested(type, dataset, query) { - this.eventBus.trigger("asyncrequest", query, dataset); - }, - _onAsyncCanceled: function onAsyncCanceled(type, dataset, query) { - this.eventBus.trigger("asynccancel", query, dataset); - }, - _onAsyncReceived: function onAsyncReceived(type, dataset, query) { - this.eventBus.trigger("asyncreceive", query, dataset); - }, - _onFocused: function onFocused() { - this._minLengthMet() && this.menu.update(this.input.getQuery()); - }, - _onBlurred: function onBlurred() { - if (this.input.hasQueryChangedSinceLastFocus()) { - this.eventBus.trigger("change", this.input.getQuery()); - } - }, - _onEnterKeyed: function onEnterKeyed(type, $e) { - var $selectable; - if ($selectable = this.menu.getActiveSelectable()) { - if (this.select($selectable)) { - $e.preventDefault(); - $e.stopPropagation(); - } - } else if (this.autoselect) { - if (this.select(this.menu.getTopSelectable())) { - $e.preventDefault(); - $e.stopPropagation(); - } - } - }, - _onTabKeyed: function onTabKeyed(type, $e) { - var $selectable; - if ($selectable = this.menu.getActiveSelectable()) { - this.select($selectable) && $e.preventDefault(); - } else if ($selectable = this.menu.getTopSelectable()) { - this.autocomplete($selectable) && $e.preventDefault(); - } - }, - _onEscKeyed: function onEscKeyed() { - this.close(); - }, - _onUpKeyed: function onUpKeyed() { - this.moveCursor(-1); - }, - _onDownKeyed: function onDownKeyed() { - this.moveCursor(+1); - }, - _onLeftKeyed: function onLeftKeyed() { - if (this.dir === "rtl" && this.input.isCursorAtEnd()) { - this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable()); - } - }, - _onRightKeyed: function onRightKeyed() { - if (this.dir === "ltr" && this.input.isCursorAtEnd()) { - this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable()); - } - }, - _onQueryChanged: function onQueryChanged(e, query) { - this._minLengthMet(query) ? this.menu.update(query) : this.menu.empty(); - }, - _onWhitespaceChanged: function onWhitespaceChanged() { - this._updateHint(); - }, - _onLangDirChanged: function onLangDirChanged(e, dir) { - if (this.dir !== dir) { - this.dir = dir; - this.menu.setLanguageDirection(dir); - } - }, - _openIfActive: function openIfActive() { - this.isActive() && this.open(); - }, - _minLengthMet: function minLengthMet(query) { - query = _.isString(query) ? query : this.input.getQuery() || ""; - return query.length >= this.minLength; - }, - _updateHint: function updateHint() { - var $selectable, data, val, query, escapedQuery, frontMatchRegEx, match; - $selectable = this.menu.getTopSelectable(); - data = this.menu.getSelectableData($selectable); - val = this.input.getInputValue(); - if (data && !_.isBlankString(val) && !this.input.hasOverflow()) { - query = Input.normalizeQuery(val); - escapedQuery = _.escapeRegExChars(query); - frontMatchRegEx = new RegExp("^(?:" + escapedQuery + ")(.+$)", "i"); - match = frontMatchRegEx.exec(data.val); - match && this.input.setHint(val + match[1]); - } else { - this.input.clearHint(); - } - }, - isEnabled: function isEnabled() { - return this.enabled; - }, - enable: function enable() { - this.enabled = true; - }, - disable: function disable() { - this.enabled = false; - }, - isActive: function isActive() { - return this.active; - }, - activate: function activate() { - if (this.isActive()) { - return true; - } else if (!this.isEnabled() || this.eventBus.before("active")) { - return false; - } else { - this.active = true; - this.eventBus.trigger("active"); - return true; - } - }, - deactivate: function deactivate() { - if (!this.isActive()) { - return true; - } else if (this.eventBus.before("idle")) { - return false; - } else { - this.active = false; - this.close(); - this.eventBus.trigger("idle"); - return true; - } - }, - isOpen: function isOpen() { - return this.menu.isOpen(); - }, - open: function open() { - if (!this.isOpen() && !this.eventBus.before("open")) { - this.menu.open(); - this._updateHint(); - this.eventBus.trigger("open"); - } - return this.isOpen(); - }, - close: function close() { - if (this.isOpen() && !this.eventBus.before("close")) { - this.menu.close(); - this.input.clearHint(); - this.input.resetInputValue(); - this.eventBus.trigger("close"); - } - return !this.isOpen(); - }, - setVal: function setVal(val) { - this.input.setQuery(_.toStr(val)); - }, - getVal: function getVal() { - return this.input.getQuery(); - }, - select: function select($selectable) { - var data = this.menu.getSelectableData($selectable); - if (data && !this.eventBus.before("select", data.obj, data.dataset)) { - this.input.setQuery(data.val, true); - this.eventBus.trigger("select", data.obj, data.dataset); - this.close(); - return true; - } - return false; - }, - autocomplete: function autocomplete($selectable) { - var query, data, isValid; - query = this.input.getQuery(); - data = this.menu.getSelectableData($selectable); - isValid = data && query !== data.val; - if (isValid && !this.eventBus.before("autocomplete", data.obj, data.dataset)) { - this.input.setQuery(data.val); - this.eventBus.trigger("autocomplete", data.obj, data.dataset); - return true; - } - return false; - }, - moveCursor: function moveCursor(delta) { - var query, $candidate, data, suggestion, datasetName, cancelMove, id; - query = this.input.getQuery(); - $candidate = this.menu.selectableRelativeToCursor(delta); - data = this.menu.getSelectableData($candidate); - suggestion = data ? data.obj : null; - datasetName = data ? data.dataset : null; - id = $candidate ? $candidate.attr("id") : null; - this.input.trigger("cursorchange", id); - cancelMove = this._minLengthMet() && this.menu.update(query); - if (!cancelMove && !this.eventBus.before("cursorchange", suggestion, datasetName)) { - this.menu.setCursor($candidate); - if (data) { - this.input.setInputValue(data.val); - } else { - this.input.resetInputValue(); - this._updateHint(); - } - this.eventBus.trigger("cursorchange", suggestion, datasetName); - return true; - } - return false; - }, - destroy: function destroy() { - this.input.destroy(); - this.menu.destroy(); - } - }); - return Typeahead; - function c(ctx) { - var methods = [].slice.call(arguments, 1); - return function() { - var args = [].slice.call(arguments); - _.each(methods, function(method) { - return ctx[method].apply(ctx, args); - }); - }; - } - }(); - (function() { - "use strict"; - var old, keys, methods; - old = $.fn.typeahead; - keys = { - www: "tt-www", - attrs: "tt-attrs", - typeahead: "tt-typeahead" - }; - methods = { - initialize: function initialize(o, datasets) { - var www; - datasets = _.isArray(datasets) ? datasets : [].slice.call(arguments, 1); - o = o || {}; - www = WWW(o.classNames); - return this.each(attach); - function attach() { - var $input, $wrapper, $hint, $menu, defaultHint, defaultMenu, eventBus, input, menu, status, typeahead, MenuConstructor; - _.each(datasets, function(d) { - d.highlight = !!o.highlight; - }); - $input = $(this); - $wrapper = $(www.html.wrapper); - $hint = $elOrNull(o.hint); - $menu = $elOrNull(o.menu); - defaultHint = o.hint !== false && !$hint; - defaultMenu = o.menu !== false && !$menu; - defaultHint && ($hint = buildHintFromInput($input, www)); - defaultMenu && ($menu = $(www.html.menu).css(www.css.menu)); - $hint && $hint.val(""); - $input = prepInput($input, www); - if (defaultHint || defaultMenu) { - $wrapper.css(www.css.wrapper); - $input.css(defaultHint ? www.css.input : www.css.inputWithNoHint); - $input.wrap($wrapper).parent().prepend(defaultHint ? $hint : null).append(defaultMenu ? $menu : null); - } - MenuConstructor = defaultMenu ? DefaultMenu : Menu; - eventBus = new EventBus({ - el: $input - }); - input = new Input({ - hint: $hint, - input: $input - }, www); - menu = new MenuConstructor({ - node: $menu, - datasets: datasets - }, www); - status = new Status({ - $input: $input, - menu: menu - }); - typeahead = new Typeahead({ - input: input, - menu: menu, - eventBus: eventBus, - minLength: o.minLength, - autoselect: o.autoselect - }, www); - $input.data(keys.www, www); - $input.data(keys.typeahead, typeahead); - } - }, - isEnabled: function isEnabled() { - var enabled; - ttEach(this.first(), function(t) { - enabled = t.isEnabled(); - }); - return enabled; - }, - enable: function enable() { - ttEach(this, function(t) { - t.enable(); - }); - return this; - }, - disable: function disable() { - ttEach(this, function(t) { - t.disable(); - }); - return this; - }, - isActive: function isActive() { - var active; - ttEach(this.first(), function(t) { - active = t.isActive(); - }); - return active; - }, - activate: function activate() { - ttEach(this, function(t) { - t.activate(); - }); - return this; - }, - deactivate: function deactivate() { - ttEach(this, function(t) { - t.deactivate(); - }); - return this; - }, - isOpen: function isOpen() { - var open; - ttEach(this.first(), function(t) { - open = t.isOpen(); - }); - return open; - }, - open: function open() { - ttEach(this, function(t) { - t.open(); - }); - return this; - }, - close: function close() { - ttEach(this, function(t) { - t.close(); - }); - return this; - }, - select: function select(el) { - var success = false, $el = $(el); - ttEach(this.first(), function(t) { - success = t.select($el); - }); - return success; - }, - autocomplete: function autocomplete(el) { - var success = false, $el = $(el); - ttEach(this.first(), function(t) { - success = t.autocomplete($el); - }); - return success; - }, - moveCursor: function moveCursoe(delta) { - var success = false; - ttEach(this.first(), function(t) { - success = t.moveCursor(delta); - }); - return success; - }, - val: function val(newVal) { - var query; - if (!arguments.length) { - ttEach(this.first(), function(t) { - query = t.getVal(); - }); - return query; - } else { - ttEach(this, function(t) { - t.setVal(_.toStr(newVal)); - }); - return this; - } - }, - destroy: function destroy() { - ttEach(this, function(typeahead, $input) { - revert($input); - typeahead.destroy(); - }); - return this; - } - }; - $.fn.typeahead = function(method) { - if (methods[method]) { - return methods[method].apply(this, [].slice.call(arguments, 1)); - } else { - return methods.initialize.apply(this, arguments); - } - }; - $.fn.typeahead.noConflict = function noConflict() { - $.fn.typeahead = old; - return this; - }; - function ttEach($els, fn) { - $els.each(function() { - var $input = $(this), typeahead; - (typeahead = $input.data(keys.typeahead)) && fn(typeahead, $input); - }); - } - function buildHintFromInput($input, www) { - return $input.clone().addClass(www.classes.hint).removeData().css(www.css.hint).css(getBackgroundStyles($input)).prop({ - readonly: true, - required: false - }).removeAttr("id name placeholder").removeClass("required").attr({ - spellcheck: "false", - tabindex: -1 - }); - } - function prepInput($input, www) { - $input.data(keys.attrs, { - dir: $input.attr("dir"), - autocomplete: $input.attr("autocomplete"), - spellcheck: $input.attr("spellcheck"), - style: $input.attr("style") - }); - $input.addClass(www.classes.input).attr({ - spellcheck: false - }); - try { - !$input.attr("dir") && $input.attr("dir", "auto"); - } catch (e) {} - return $input; - } - function getBackgroundStyles($el) { - return { - backgroundAttachment: $el.css("background-attachment"), - backgroundClip: $el.css("background-clip"), - backgroundColor: $el.css("background-color"), - backgroundImage: $el.css("background-image"), - backgroundOrigin: $el.css("background-origin"), - backgroundPosition: $el.css("background-position"), - backgroundRepeat: $el.css("background-repeat"), - backgroundSize: $el.css("background-size") - }; - } - function revert($input) { - var www, $wrapper; - www = $input.data(keys.www); - $wrapper = $input.parent().filter(www.selectors.wrapper); - _.each($input.data(keys.attrs), function(val, key) { - _.isUndefined(val) ? $input.removeAttr(key) : $input.attr(key, val); - }); - $input.removeData(keys.typeahead).removeData(keys.www).removeData(keys.attr).removeClass(www.classes.input); - if ($wrapper.length) { - $input.detach().insertAfter($wrapper); - $wrapper.remove(); - } - } - function $elOrNull(obj) { - var isValid, $el; - isValid = _.isJQuery(obj) || _.isElement(obj); - $el = isValid ? $(obj).first() : []; - return $el.length ? $el : null; - } - })(); -}); \ No newline at end of file diff --git a/docs/search.json b/docs/search.json deleted file mode 100644 index 2b66ccdb..00000000 --- a/docs/search.json +++ /dev/null @@ -1 +0,0 @@ -{"Typealiases.html#/s:12XCoordinator24AnyNavigationCoordinatora":{"name":"AnyNavigationCoordinator","abstract":"

A type-erased Coordinator (AnyCoordinator) with a UINavigationController as rootViewController.

"},"Typealiases.html#/s:12XCoordinator20AnyTabBarCoordinatora":{"name":"AnyTabBarCoordinator","abstract":"

A type-erased Coordinator (AnyCoordinator) with a UITabBarController as rootViewController.

"},"Typealiases.html#/s:12XCoordinator18AnyViewCoordinatora":{"name":"AnyViewCoordinator","abstract":"

A type-erased Coordinator (AnyCoordinator) with a UIViewController as rootViewController.

"},"Typealiases.html#/s:12XCoordinator26BasicNavigationCoordinatora":{"name":"BasicNavigationCoordinator","abstract":"

A BasicCoordinator with a UINavigationController as its rootViewController.

"},"Typealiases.html#/s:12XCoordinator20BasicViewCoordinatora":{"name":"BasicViewCoordinator","abstract":"

A BasicCoordinator with a UIViewController as its rootViewController.

"},"Typealiases.html#/s:12XCoordinator22BasicTabBarCoordinatora":{"name":"BasicTabBarCoordinator","abstract":"

A BasicCoordinator with a UITabBarController as its rootViewController.

"},"Typealiases.html#/s:12XCoordinator19PresentationHandlera":{"name":"PresentationHandler","abstract":"

The completion handler for transitions.

"},"Typealiases.html#/s:12XCoordinator26ContextPresentationHandlera":{"name":"ContextPresentationHandler","abstract":"

The completion handler for transitions, which also provides the context information about the transition.

"},"Typealiases.html#/s:12XCoordinator20NavigationTransitiona":{"name":"NavigationTransition","abstract":"

NavigationTransition offers transitions that can be used"},"Typealiases.html#/s:12XCoordinator14PageTransitiona":{"name":"PageTransition","abstract":"

PageTransition offers transitions that can be used"},"Typealiases.html#/s:12XCoordinator15SplitTransitiona":{"name":"SplitTransition","abstract":"

SplitTransition offers different transitions common to a UISplitViewController rootViewController.

"},"Typealiases.html#/s:12XCoordinator16TabBarTransitiona":{"name":"TabBarTransition","abstract":"

TabBarTransition offers transitions that can be used"},"Typealiases.html#/s:12XCoordinator9AnyRoutera":{"name":"AnyRouter","abstract":"

Please use StrongRouter, WeakRouter or UnownedRouter instead.

"},"Typealiases.html#/s:12XCoordinator13UnownedRoutera":{"name":"UnownedRouter","abstract":"

An UnownedRouter is an unowned version of a router object to be used in view controllers or view models.

"},"Typealiases.html#/s:12XCoordinator14ViewTransitiona":{"name":"ViewTransition","abstract":"

ViewTransition offers transitions common to any UIViewController rootViewController.

"},"Typealiases.html#/s:12XCoordinator10WeakRoutera":{"name":"WeakRouter","abstract":"

A WeakRouter is a weak version of a router object to be used in view controllers or view models.

"},"Structs/WeakErased.html#/wrappedValue":{"name":"wrappedValue","abstract":"

The type-erased or otherwise mapped version of the value being held weakly.

","parent_name":"WeakErased"},"Structs/WeakErased.html#/s:12XCoordinator10WeakErasedV12wrappedValuexSgvp":{"name":"wrappedValue","abstract":"

The type-erased or otherwise mapped version of the value being held weakly.

","parent_name":"WeakErased"},"Structs/WeakErased.html#/s:12XCoordinator11PresentableP14viewControllerSo06UIViewD0CSgvp":{"name":"viewController","parent_name":"WeakErased"},"Structs/WeakErased.html#/s:12XCoordinator11PresentableP24childTransitionCompletedyyF":{"name":"childTransitionCompleted()","parent_name":"WeakErased"},"Structs/WeakErased.html#/s:12XCoordinator11PresentableP14registerParentyyAaB_XlF":{"name":"registerParent(_:)","parent_name":"WeakErased"},"Structs/WeakErased.html#/s:12XCoordinator11PresentableP9presented4fromyAaB_pSg_tF":{"name":"presented(from:)","parent_name":"WeakErased"},"Structs/WeakErased.html#/s:12XCoordinator11PresentableP7setRoot3forySo8UIWindowC_tF":{"name":"setRoot(for:)","parent_name":"WeakErased"},"Structs/WeakErased.html#/s:12XCoordinator6RouterP14contextTrigger_4with10completiony9RouteTypeQz_AA17TransitionOptionsVyAA0I7Context_pcSgtF":{"name":"contextTrigger(_:with:completion:)","parent_name":"WeakErased"},"Structs/WeakErased.html#/s:12XCoordinator10WeakErasedV_5eraseACyxGqd___xqd__ctcRld__Clufc":{"name":"init(_:erase:)","abstract":"

Create a WeakErased wrapper using an initial value and a closure to create the type-erased object.","parent_name":"WeakErased"},"Structs/WeakErased.html#/s:12XCoordinator10WeakErasedV3set_5eraseyqd___xqd__ctRld__ClF":{"name":"set(_:erase:)","abstract":"

Set a new value by providing a non-type-erased value and a closure to create the type-erased object.

","parent_name":"WeakErased"},"Structs/UnownedErased.html#/wrappedValue":{"name":"wrappedValue","abstract":"

The type-erased or otherwise mapped version of the value being held unowned.

","parent_name":"UnownedErased"},"Structs/UnownedErased.html#/s:12XCoordinator13UnownedErasedV12wrappedValuexvp":{"name":"wrappedValue","abstract":"

The type-erased or otherwise mapped version of the value being held unowned.

","parent_name":"UnownedErased"},"Structs/UnownedErased.html#/s:12XCoordinator11PresentableP14viewControllerSo06UIViewD0CSgvp":{"name":"viewController","parent_name":"UnownedErased"},"Structs/UnownedErased.html#/s:12XCoordinator11PresentableP24childTransitionCompletedyyF":{"name":"childTransitionCompleted()","parent_name":"UnownedErased"},"Structs/UnownedErased.html#/s:12XCoordinator11PresentableP14registerParentyyAaB_XlF":{"name":"registerParent(_:)","parent_name":"UnownedErased"},"Structs/UnownedErased.html#/s:12XCoordinator11PresentableP9presented4fromyAaB_pSg_tF":{"name":"presented(from:)","parent_name":"UnownedErased"},"Structs/UnownedErased.html#/s:12XCoordinator11PresentableP7setRoot3forySo8UIWindowC_tF":{"name":"setRoot(for:)","parent_name":"UnownedErased"},"Structs/UnownedErased.html#/s:12XCoordinator6RouterP14contextTrigger_4with10completiony9RouteTypeQz_AA17TransitionOptionsVyAA0I7Context_pcSgtF":{"name":"contextTrigger(_:with:completion:)","parent_name":"UnownedErased"},"Structs/UnownedErased.html#/s:12XCoordinator13UnownedErasedV_5eraseACyxGqd___xqd__ctcRld__Clufc":{"name":"init(_:erase:)","abstract":"

Create an UnownedErased wrapper using an initial value and a closure to create the type-erased object.","parent_name":"UnownedErased"},"Structs/UnownedErased.html#/s:12XCoordinator13UnownedErasedV3set_5eraseyqd___xqd__ctRld__ClF":{"name":"set(_:erase:)","abstract":"

Set a new value by providing a non-type-erased value and a closure to create the type-erased object.

","parent_name":"UnownedErased"},"Structs/TransitionOptions.html#/s:12XCoordinator17TransitionOptionsV8animatedSbvp":{"name":"animated","abstract":"

Specifies whether or not the transition should be animated.

","parent_name":"TransitionOptions"},"Structs/TransitionOptions.html#/s:12XCoordinator17TransitionOptionsV8animatedACSb_tcfc":{"name":"init(animated:)","abstract":"

Creates transition options on the basis of whether or not it should be animated.

","parent_name":"TransitionOptions"},"Structs/Transition.html#/s:12XCoordinator10TransitionV14PerformClosurea":{"name":"PerformClosure","abstract":"

Perform is the type of closure used to perform the transition.

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV12presentablesSayAA11Presentable_pGvp":{"name":"presentables","abstract":"

The presentables this transition is putting into the view hierarchy. This is especially useful for","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV9animationAA0B9Animation_pSgvp":{"name":"animation","abstract":"

The transition animation this transition is using, i.e. the presentation or dismissal animation","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV12presentables14animationInUse7performACyxGSayAA11Presentable_pG_AA0B9Animation_pSgyx_AA0B7OptionsVyycSgtctcfc":{"name":"init(presentables:animationInUse:perform:)","abstract":"

Create your custom transitions with this initializer.

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV7perform2on4with10completionyx_AA0B7OptionsVyycSgtF":{"name":"perform(on:with:completion:)","abstract":"

Performs a transition on the given viewController.

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionVAASo22UINavigationControllerCRbzrlE4push_9animationACyxGAA11Presentable_p_AA9AnimationCSgtFZ":{"name":"push(_:animation:)","abstract":"

Pushes a presentable on the rootViewController’s navigation stack.

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionVAASo22UINavigationControllerCRbzrlE3pop9animationACyxGAA9AnimationCSg_tFZ":{"name":"pop(animation:)","abstract":"

Pops the topViewController from the rootViewController’s navigation stack.

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionVAASo22UINavigationControllerCRbzrlE3pop2to9animationACyxGAA11Presentable_p_AA9AnimationCSgtFZ":{"name":"pop(to:animation:)","abstract":"

Pops viewControllers from the rootViewController’s navigation stack until the specified","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionVAASo22UINavigationControllerCRbzrlE9popToRoot9animationACyxGAA9AnimationCSg_tFZ":{"name":"popToRoot(animation:)","abstract":"

Pops viewControllers from the rootViewController’s navigation stack until only one viewController","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionVAASo22UINavigationControllerCRbzrlE3set_9animationACyxGSayAA11Presentable_pG_AA9AnimationCSgtFZ":{"name":"set(_:animation:)","abstract":"

Replaces the navigation stack of the rootViewController with the specified presentables.

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionVAASo20UIPageViewControllerCRbzrlE3set__9directionACyxGAA11Presentable_p_AaI_pSgSo0cdE19NavigationDirectionVtFZ":{"name":"set(_:_:direction:)","abstract":"

Sets the current page(s) of the rootViewController. Make sure to set","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionVAASo18UITabBarControllerCRbzrlE3set_9animationACyxGSayAA11Presentable_pG_AA9AnimationCSgtFZ":{"name":"set(_:animation:)","abstract":"

Transition to set the tabs of the rootViewController with an optional custom animation.

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionVAASo18UITabBarControllerCRbzrlE6select_9animationACyxGAA11Presentable_p_AA9AnimationCSgtFZ":{"name":"select(_:animation:)","abstract":"

Transition to select a tab with an optional custom animation.

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionVAASo18UITabBarControllerCRbzrlE6select5index9animationACyxGSi_AA9AnimationCSgtFZ":{"name":"select(index:animation:)","abstract":"

Transition to select a tab with an optional custom animation.

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV4showyACyxGAA11Presentable_pFZ":{"name":"show(_:)","abstract":"

Shows a viewController by calling show on the rootViewController.

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV10showDetailyACyxGAA11Presentable_pFZ":{"name":"showDetail(_:)","abstract":"

Shows a detail viewController by calling showDetail on the rootViewController.

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV13presentOnRoot_9animationACyxGAA11Presentable_p_AA9AnimationCSgtFZ":{"name":"presentOnRoot(_:animation:)","abstract":"

Transition to present the given presentable on the rootViewController.

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV7present_9animationACyxGAA11Presentable_p_AA9AnimationCSgtFZ":{"name":"present(_:animation:)","abstract":"

Transition to present the given presentable. It uses the rootViewController’s presentedViewController,","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV5embed_2inACyxGAA11Presentable_p_AA9Container_ptFZ":{"name":"embed(_:in:)","abstract":"

Transition to embed the given presentable in a specific container (i.e. a view or viewController).

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV13dismissToRoot9animationACyxGAA9AnimationCSg_tFZ":{"name":"dismissToRoot(animation:)","abstract":"

Transition to call dismiss on the rootViewController. Also take a look at the dismiss transition,","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV7dismiss9animationACyxGAA9AnimationCSg_tFZ":{"name":"dismiss(animation:)","abstract":"

Transition to call dismiss on the rootViewController’s presentedViewController, if present.","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV4noneACyxGyFZ":{"name":"none()","abstract":"

No transition at all. May be useful for testing or debugging purposes, or to ignore specific","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV8multipleyACyxGqd__SlRd__AE7ElementRtd__lFZ":{"name":"multiple(_:)","abstract":"

With this transition you can chain multiple transitions of the same type together.

","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV5route_2onACyxG9RouteTypeQyd___qd__tAA11CoordinatorRd__lFZ":{"name":"route(_:on:)","abstract":"

Use this transition to trigger a route on another coordinator. TransitionOptions and","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV7trigger_2onACyxG9RouteTypeQyd___qd__tAA6RouterRd__lFZ":{"name":"trigger(_:on:)","abstract":"

Use this transition to trigger a route on another router. TransitionOptions and","parent_name":"Transition"},"Structs/Transition.html#/s:12XCoordinator10TransitionV7perform_2onACyxGqd___18RootViewControllerQyd__tAA0B8ProtocolRd__lFZ":{"name":"perform(_:on:)","abstract":"

Performs a transition on a different viewController than the coordinator’s rootViewController.

","parent_name":"Transition"},"Structs/Transition.html":{"name":"Transition","abstract":"

This struct represents the common implementation of the TransitionProtocol."},"Structs/TransitionOptions.html":{"name":"TransitionOptions","abstract":"

TransitionOptions specifies transition customization points defined at the point of triggering a transition.

"},"Structs/UnownedErased.html":{"name":"UnownedErased","abstract":"

UnownedErased is a property wrapper to hold objects with an unowned reference when using type-erasure.

"},"Structs/WeakErased.html":{"name":"WeakErased","abstract":"

WeakErased is a property wrapper to hold objects with a weak reference when using type-erasure.

"},"Protocols/TransitionProtocol.html#/s:12XCoordinator18TransitionProtocolP18RootViewControllerQa":{"name":"RootViewController","abstract":"

The type of the rootViewController that can execute the transition.

","parent_name":"TransitionProtocol"},"Protocols/TransitionProtocol.html#/s:12XCoordinator18TransitionProtocolP7perform2on4with10completiony18RootViewControllerQz_AA0B7OptionsVyycSgtF":{"name":"perform(on:with:completion:)","abstract":"

Performs a transition on the given viewController.

","parent_name":"TransitionProtocol"},"Protocols/TransitionProtocol.html#/s:12XCoordinator18TransitionProtocolP8multipleyxSayxGFZ":{"name":"multiple(_:)","abstract":"

Creates a compound transition by chaining multiple transitions together.

","parent_name":"TransitionProtocol"},"Protocols/TransitionPerformer.html#/s:12XCoordinator19TransitionPerformerP0B4TypeQa":{"name":"TransitionType","abstract":"

The type of transitions that can be executed on the rootViewController.

","parent_name":"TransitionPerformer"},"Protocols/TransitionPerformer.html#/s:12XCoordinator19TransitionPerformerP18rootViewController0B4Type_04RooteF0QZvp":{"name":"rootViewController","abstract":"

The rootViewController on which transitions are performed.

","parent_name":"TransitionPerformer"},"Protocols/TransitionPerformer.html#/s:12XCoordinator19TransitionPerformerP07performB0_4with10completiony0B4TypeQz_AA0B7OptionsVyycSgtF":{"name":"performTransition(_:with:completion:)","abstract":"

Perform a transition.

","parent_name":"TransitionPerformer"},"Protocols/PercentDrivenInteractionController.html#/s:12XCoordinator34PercentDrivenInteractionControllerP6updateyy12CoreGraphics7CGFloatVF":{"name":"update(_:)","abstract":"

Updates the animation to be at the specified progress.

","parent_name":"PercentDrivenInteractionController"},"Protocols/PercentDrivenInteractionController.html#/s:12XCoordinator34PercentDrivenInteractionControllerP6cancelyyF":{"name":"cancel()","abstract":"

Cancels the animation, e.g. by cleaning up and reversing any progress made.

","parent_name":"PercentDrivenInteractionController"},"Protocols/PercentDrivenInteractionController.html#/s:12XCoordinator34PercentDrivenInteractionControllerP6finishyyF":{"name":"finish()","abstract":"

Finishes the animation by completing it from the current progress onwards.

","parent_name":"PercentDrivenInteractionController"},"Protocols/TransitionAnimation.html#/s:12XCoordinator19TransitionAnimationP21interactionControllerAA024PercentDrivenInteractionE0_pSgvp":{"name":"interactionController","abstract":"

The interaction controller of an animation.","parent_name":"TransitionAnimation"},"Protocols/TransitionAnimation.html#/s:12XCoordinator19TransitionAnimationP5startyyF":{"name":"start()","abstract":"

Starts the animation by possibly creating a new interaction controller.

","parent_name":"TransitionAnimation"},"Protocols/TransitionAnimation.html#/s:12XCoordinator19TransitionAnimationP7cleanupyyF":{"name":"cleanup()","abstract":"

Cleans up a TransitionAnimation after an animation has been completed, e.g. by deleting an interaction controller.

","parent_name":"TransitionAnimation"},"Protocols/Router.html#/s:12XCoordinator6RouterP9RouteTypeQa":{"name":"RouteType","abstract":"

RouteType defines which routes can be triggered in a certain Router implementation.

","parent_name":"Router"},"Protocols/Router.html#/s:12XCoordinator6RouterP14contextTrigger_4with10completiony9RouteTypeQz_AA17TransitionOptionsVyAA0I7Context_pcSgtF":{"name":"contextTrigger(_:with:completion:)","abstract":"

Triggers routes and returns context in completion-handler.

","parent_name":"Router"},"Protocols/Router.html#/s:12XCoordinator6RouterPAAE7trigger_4withy9RouteTypeQz_AA17TransitionOptionsVtF":{"name":"trigger(_:with:)","abstract":"

Triggers the specified route without the need of specifying a completion handler.

","parent_name":"Router"},"Protocols/Router.html#/s:12XCoordinator6RouterPAAE7trigger_10completiony9RouteTypeQz_yycSgtF":{"name":"trigger(_:completion:)","abstract":"

Triggers the specified route with default transition options enabling the animation of the transition.

","parent_name":"Router"},"Protocols/Router.html#/s:12XCoordinator6RouterPAAE7trigger_4with10completiony9RouteTypeQz_AA17TransitionOptionsVyycSgtF":{"name":"trigger(_:with:completion:)","abstract":"

Triggers the specified route by performing a transition.

","parent_name":"Router"},"Protocols/Router.html#/s:12XCoordinator6RouterPAAE06strongB0AA06StrongB0Cy9RouteTypeQzGvp":{"name":"strongRouter","abstract":"

Creates a StrongRouter object from the given router to abstract from concrete implementations","parent_name":"Router"},"Protocols/Router.html#/s:12XCoordinator6RouterPAAE6router3forAA06StrongB0Cyqd__GSgqd___tAA5RouteRd__lF":{"name":"router(for:)","abstract":"

Returns a router for the specified route, if possible.

","parent_name":"Router"},"Protocols/Presentable.html#/s:12XCoordinator11PresentableP14viewControllerSo06UIViewD0CSgvp":{"name":"viewController","abstract":"

The viewController of the Presentable.

","parent_name":"Presentable"},"Protocols/Presentable.html#/s:12XCoordinator11PresentableP6router3forAA12StrongRouterCyqd__GSgqd___tAA5RouteRd__lF":{"name":"router(for:)","abstract":"

This method can be used to retrieve whether the presentable can trigger a specific route","parent_name":"Presentable"},"Protocols/Presentable.html#/s:12XCoordinator11PresentableP9presented4fromyAaB_pSg_tF":{"name":"presented(from:)","abstract":"

This method is called whenever a Presentable is shown to the user.","parent_name":"Presentable"},"Protocols/Presentable.html#/s:12XCoordinator11PresentableP14registerParentyyAaB_XlF":{"name":"registerParent(_:)","abstract":"

This method is used to register a parent coordinator to a child coordinator.

","parent_name":"Presentable"},"Protocols/Presentable.html#/s:12XCoordinator11PresentableP24childTransitionCompletedyyF":{"name":"childTransitionCompleted()","abstract":"

This method gets called when the transition of a child coordinator is being reported to its parent.

","parent_name":"Presentable"},"Protocols/Presentable.html#/s:12XCoordinator11PresentableP7setRoot3forySo8UIWindowC_tF":{"name":"setRoot(for:)","abstract":"

Sets the presentable as the root of the window.

","parent_name":"Presentable"},"Protocols/TransitionContext.html#/s:12XCoordinator17TransitionContextP12presentablesSayAA11Presentable_pGvp":{"name":"presentables","abstract":"

The presentables being shown to the user by the transition.

","parent_name":"TransitionContext"},"Protocols/TransitionContext.html#/s:12XCoordinator17TransitionContextP9animationAA0B9Animation_pSgvp":{"name":"animation","abstract":"

The transition animation directly used in the transition, if applicable.

","parent_name":"TransitionContext"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorP17prepareTransition3for0D4TypeQz05RouteF0Qz_tF":{"name":"prepareTransition(for:)","abstract":"

This method prepares transitions for routes.","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorP8addChildyyAA11Presentable_pF":{"name":"addChild(_:)","abstract":"

This method adds a child to a coordinator’s children.

","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorP11removeChildyyAA11Presentable_pF":{"name":"removeChild(_:)","abstract":"

This method removes a child to a coordinator’s children.

","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorP22removeChildrenIfNeededyyF":{"name":"removeChildrenIfNeeded()","abstract":"

This method removes all children that are no longer in the view hierarchy.

","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAAE18RootViewControllera":{"name":"RootViewController","abstract":"

Shortcut for Coordinator.TransitionType.RootViewController

","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAAE14viewControllerSo06UIViewD0CSgvp":{"name":"viewController","abstract":"

A Coordinator uses its rootViewController as viewController.

","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAARlzCrlE10weakRouterAA10WeakErasedVyAA06StrongD0Cy9RouteTypeQzGGvp":{"name":"weakRouter","abstract":"

Creates a WeakRouter object from the given router to abstract from concrete implementations","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAARlzCrlE13unownedRouterAA13UnownedErasedVyAA06StrongD0Cy9RouteTypeQzGGvp":{"name":"unownedRouter","abstract":"

Creates an UnownedRouter object from the given router to abstract from concrete implementations","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAARlzCrlE03anyB0AA03AnyB0Cy9RouteTypeQz010TransitionF0QzGvp":{"name":"anyCoordinator","abstract":"

Creates an AnyCoordinator based on the current coordinator.

","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11PresentableP9presented4fromyAaB_pSg_tF":{"name":"presented(from:)","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11PresentableP24childTransitionCompletedyyF":{"name":"childTransitionCompleted()","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAARlzCrlE14contextTrigger_4with10completiony9RouteTypeQz_AA17TransitionOptionsVyAA0I7Context_pcSgtF":{"name":"contextTrigger(_:with:completion:)","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAARlzCrlE5chain6routes14TransitionTypeQzSay05RouteF0QzG_tF":{"name":"chain(routes:)","abstract":"

With chain(routes:) different routes can be chained together to form a combined transition.

","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator19TransitionPerformerP07performB0_4with10completiony0B4TypeQz_AA0B7OptionsVyycSgtF":{"name":"performTransition(_:with:completion:)","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAARlzCrlE8deepLinkyAA10TransitionVyqd__G9RouteTypeQz_qd_0_tSo16UIViewControllerCRbd__STRd_0_AG0eG0RtzAA0F0_p7ElementRtd_0_r0_lF":{"name":"deepLink(_:_:)","abstract":"

Deep-Linking can be used to chain routes of different types together.

","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAARlzCrlE8deepLinkyAA10TransitionVyqd__G9RouteTypeQz_AA0F0_pdtSo16UIViewControllerCRbd__AG0eG0RtzlF":{"name":"deepLink(_:_:)","abstract":"

Deep-Linking can be used to chain routes of different types together.

","parent_name":"Coordinator"},"Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAARlzCrlE12registerPeek3for5routeAA10TransitionVyqd__GAA9Container_p_9RouteTypeQztSo16UIViewControllerCRbd__AI0gJ0RtzlF":{"name":"registerPeek(for:route:)","abstract":"

Use this transition to register 3D Touch Peek and Pop functionality.

","parent_name":"Coordinator"},"Protocols/Container.html#/s:12XCoordinator9ContainerP4viewSo6UIViewCSgvp":{"name":"view","abstract":"

The view of the Container.

","parent_name":"Container"},"Protocols/Container.html#/s:12XCoordinator9ContainerP14viewControllerSo06UIViewD0CSgvp":{"name":"viewController","abstract":"

The viewController of the Container.

","parent_name":"Container"},"Protocols/Container.html":{"name":"Container","abstract":"

Container abstracts away from the difference of UIView and UIViewController

"},"Protocols/Coordinator.html":{"name":"Coordinator","abstract":"

Coordinator is the protocol every coordinator conforms to.

"},"Protocols/TransitionContext.html":{"name":"TransitionContext","abstract":"

TransitionContext provides context information about transitions.

"},"Protocols/Presentable.html":{"name":"Presentable","abstract":"

Presentable represents all objects that can be presented (i.e. shown) to the user.

"},"Protocols.html#/s:12XCoordinator5RouteP":{"name":"Route","abstract":"

This is the protocol your route types need to conform to.

"},"Protocols/Router.html":{"name":"Router","abstract":"

The Router protocol is used to abstract the transition-type specific characteristics of a Coordinator.

"},"Protocols/TransitionAnimation.html":{"name":"TransitionAnimation","abstract":"

TransitionAnimation aims to provide a common protocol for any type of transition animation used in an Animation object.

"},"Protocols/PercentDrivenInteractionController.html":{"name":"PercentDrivenInteractionController","abstract":"

PercentDrivenInteractionController is used for interaction controller types that can updated based on a percentage of completion."},"Protocols/TransitionPerformer.html":{"name":"TransitionPerformer","abstract":"

The TransitionPerformer protocol is used to abstract the route-type specific characteristics of a Coordinator."},"Protocols/TransitionProtocol.html":{"name":"TransitionProtocol","abstract":"

TransitionProtocol is used to abstract any concrete transition implementation.

"},"Extensions/UIView.html#/s:12XCoordinator9ContainerP14viewControllerSo06UIViewD0CSgvp":{"name":"viewController","parent_name":"UIView"},"Extensions/UIView.html#/s:12XCoordinator9ContainerP4viewSo6UIViewCSgvp":{"name":"view","parent_name":"UIView"},"Extensions/UIViewController.html#/s:12XCoordinator9ContainerP14viewControllerSo06UIViewD0CSgvp":{"name":"viewController","parent_name":"UIViewController"},"Extensions/UIViewController.html":{"name":"UIViewController"},"Extensions/UIView.html":{"name":"UIView"},"Classes/ViewCoordinator.html#/s:12XCoordinator15ViewCoordinatorC04rootB10Controller12initialRouteACyxGSo06UIViewE0C_xSgtcfc":{"name":"init(rootViewController:initialRoute:)","parent_name":"ViewCoordinator"},"Classes/TabBarCoordinator.html#/s:12XCoordinator17TabBarCoordinatorC8delegateSo05UITabC18ControllerDelegate_pSgvp":{"name":"delegate","abstract":"

Use this delegate to get informed about tabbarController-related notifications and delegate methods","parent_name":"TabBarCoordinator"},"Classes/TabBarCoordinator.html#/s:12XCoordinator17TabBarCoordinatorC18rootViewController12initialRouteACyxGSo05UITabcG0C_xSgtcfc":{"name":"init(rootViewController:initialRoute:)","parent_name":"TabBarCoordinator"},"Classes/TabBarCoordinator.html#/s:12XCoordinator17TabBarCoordinatorC18rootViewController4tabsACyxGSo05UITabcG0C_SayAA11Presentable_pGtcfc":{"name":"init(rootViewController:tabs:)","abstract":"

Creates a TabBarCoordinator with a specified set of tabs.

","parent_name":"TabBarCoordinator"},"Classes/TabBarCoordinator.html#/s:12XCoordinator17TabBarCoordinatorC18rootViewController4tabs6selectACyxGSo05UITabcG0C_SayAA11Presentable_pGAaJ_ptcfc":{"name":"init(rootViewController:tabs:select:)","abstract":"

Creates a TabBarCoordinator with a specified set of tabs and selects a specific presentable.

","parent_name":"TabBarCoordinator"},"Classes/TabBarCoordinator.html#/s:12XCoordinator17TabBarCoordinatorC18rootViewController4tabs6selectACyxGSo05UITabcG0C_SayAA11Presentable_pGSitcfc":{"name":"init(rootViewController:tabs:select:)","abstract":"

Creates a TabBarCoordinator with a specified set of tabs and selects a presentable at a given index.

","parent_name":"TabBarCoordinator"},"Classes/TabBarAnimationDelegate.html#/c:@CM@XCoordinator@objc(cs)TabBarAnimationDelegate(im)tabBarController:interactionControllerForAnimationController:":{"name":"tabBarController(_:interactionControllerFor:)","abstract":"

See UITabBarControllerDelegate","parent_name":"TabBarAnimationDelegate"},"Classes/TabBarAnimationDelegate.html#/c:@CM@XCoordinator@objc(cs)TabBarAnimationDelegate(im)tabBarController:animationControllerForTransitionFromViewController:toViewController:":{"name":"tabBarController(_:animationControllerForTransitionFrom:to:)","abstract":"

See UITabBarControllerDelegate","parent_name":"TabBarAnimationDelegate"},"Classes/TabBarAnimationDelegate.html#/c:@CM@XCoordinator@objc(cs)TabBarAnimationDelegate(im)tabBarController:didSelectViewController:":{"name":"tabBarController(_:didSelect:)","abstract":"

See UITabBarControllerDelegate","parent_name":"TabBarAnimationDelegate"},"Classes/TabBarAnimationDelegate.html#/c:@CM@XCoordinator@objc(cs)TabBarAnimationDelegate(im)tabBarController:shouldSelectViewController:":{"name":"tabBarController(_:shouldSelect:)","abstract":"

See UITabBarControllerDelegate","parent_name":"TabBarAnimationDelegate"},"Classes/TabBarAnimationDelegate.html#/c:@CM@XCoordinator@objc(cs)TabBarAnimationDelegate(im)tabBarController:willBeginCustomizingViewControllers:":{"name":"tabBarController(_:willBeginCustomizing:)","abstract":"

See UITabBarControllerDelegate","parent_name":"TabBarAnimationDelegate"},"Classes/TabBarAnimationDelegate.html#/c:@CM@XCoordinator@objc(cs)TabBarAnimationDelegate(im)tabBarController:didEndCustomizingViewControllers:changed:":{"name":"tabBarController(_:didEndCustomizing:changed:)","abstract":"

See UITabBarControllerDelegate","parent_name":"TabBarAnimationDelegate"},"Classes/TabBarAnimationDelegate.html#/c:@CM@XCoordinator@objc(cs)TabBarAnimationDelegate(im)tabBarController:willEndCustomizingViewControllers:changed:":{"name":"tabBarController(_:willEndCustomizing:changed:)","abstract":"

See UITabBarControllerDelegate","parent_name":"TabBarAnimationDelegate"},"Classes/StrongRouter.html#/s:12XCoordinator12StrongRouterCyACyxGqd__c9RouteTypeQyd__RszAA0C0Rd__lufc":{"name":"init(_:)","abstract":"

Creates a StrongRouter object from a given router.

","parent_name":"StrongRouter"},"Classes/StrongRouter.html#/s:12XCoordinator12StrongRouterC14contextTrigger_4with10completionyx_AA17TransitionOptionsVyAA0H7Context_pcSgtF":{"name":"contextTrigger(_:with:completion:)","abstract":"

Triggers routes and provides the transition context in the completion-handler.

","parent_name":"StrongRouter"},"Classes/StrongRouter.html#/s:12XCoordinator12StrongRouterC7trigger_4with10completionyx_AA17TransitionOptionsVyycSgtF":{"name":"trigger(_:with:completion:)","abstract":"

Triggers the specified route by performing a transition.

","parent_name":"StrongRouter"},"Classes/StrongRouter.html#/s:12XCoordinator12StrongRouterC9presented4fromyAA11Presentable_pSg_tF":{"name":"presented(from:)","abstract":"

This method is called whenever a Presentable is shown to the user.","parent_name":"StrongRouter"},"Classes/StrongRouter.html#/s:12XCoordinator12StrongRouterC14viewControllerSo06UIViewE0CSgvp":{"name":"viewController","abstract":"

The viewController of the Presentable.

","parent_name":"StrongRouter"},"Classes/StrongRouter.html#/s:12XCoordinator11PresentableP14registerParentyyAaB_XlF":{"name":"registerParent(_:)","parent_name":"StrongRouter"},"Classes/StrongRouter.html#/s:12XCoordinator11PresentableP24childTransitionCompletedyyF":{"name":"childTransitionCompleted()","parent_name":"StrongRouter"},"Classes/StaticTransitionAnimation.html#/s:12XCoordinator19TransitionAnimationP21interactionControllerAA024PercentDrivenInteractionE0_pSgvp":{"name":"interactionController","parent_name":"StaticTransitionAnimation"},"Classes/StaticTransitionAnimation.html#/s:12XCoordinator25StaticTransitionAnimationC8duration07performD0ACSd_ySo36UIViewControllerContextTransitioning_pctcfc":{"name":"init(duration:performAnimation:)","abstract":"

Creates a StaticTransitionAnimation to be used as presentation or dismissal transition animation in","parent_name":"StaticTransitionAnimation"},"Classes/StaticTransitionAnimation.html#/c:@M@XCoordinator@objc(cs)StaticTransitionAnimation(im)transitionDuration:":{"name":"transitionDuration(using:)","abstract":"

See UIViewControllerAnimatedTransitioning","parent_name":"StaticTransitionAnimation"},"Classes/StaticTransitionAnimation.html#/c:@M@XCoordinator@objc(cs)StaticTransitionAnimation(im)animateTransition:":{"name":"animateTransition(using:)","abstract":"

See UIViewControllerAnimatedTransitioning","parent_name":"StaticTransitionAnimation"},"Classes/StaticTransitionAnimation.html#/s:12XCoordinator19TransitionAnimationP5startyyF":{"name":"start()","parent_name":"StaticTransitionAnimation"},"Classes/StaticTransitionAnimation.html#/s:12XCoordinator19TransitionAnimationP7cleanupyyF":{"name":"cleanup()","parent_name":"StaticTransitionAnimation"},"Classes/SplitCoordinator.html#/s:12XCoordinator16SplitCoordinatorC18rootViewController12initialRouteACyxGSo07UISpliteF0C_xSgtcfc":{"name":"init(rootViewController:initialRoute:)","parent_name":"SplitCoordinator"},"Classes/SplitCoordinator.html#/s:12XCoordinator16SplitCoordinatorC18rootViewController6master6detailACyxGSo07UISpliteF0C_AA11Presentable_pAaJ_pSgtcfc":{"name":"init(rootViewController:master:detail:)","abstract":"

Creates a SplitCoordinator and sets the specified presentables as the rootViewController’s","parent_name":"SplitCoordinator"},"Classes/RedirectionRouter.html#/s:12XCoordinator17RedirectionRouterC6parentAA13UnownedErasedVyAA06StrongC0CyxGGvp":{"name":"parent","abstract":"

A type-erased Router object of the parent router.

","parent_name":"RedirectionRouter"},"Classes/RedirectionRouter.html#/s:12XCoordinator17RedirectionRouterC14viewControllerSo06UIViewE0CSgvp":{"name":"viewController","abstract":"

The viewController used in transitions, e.g. when pushing, presenting","parent_name":"RedirectionRouter"},"Classes/RedirectionRouter.html#/s:12XCoordinator17RedirectionRouterC14viewController6parent3mapACyxq_GSo06UIViewE0C_AA13UnownedErasedVyAA06StrongC0CyxGGxq_cSgtcfc":{"name":"init(viewController:parent:map:)","abstract":"

Creates a RedirectionRouter with a certain viewController, a parent router","parent_name":"RedirectionRouter"},"Classes/RedirectionRouter.html#/s:12XCoordinator6RouterP14contextTrigger_4with10completiony9RouteTypeQz_AA17TransitionOptionsVyAA0I7Context_pcSgtF":{"name":"contextTrigger(_:with:completion:)","parent_name":"RedirectionRouter"},"Classes/RedirectionRouter.html#/s:12XCoordinator17RedirectionRouterC16mapToParentRouteyxq_F":{"name":"mapToParentRoute(_:)","abstract":"

Map RouteType to ParentRoute.

","parent_name":"RedirectionRouter"},"Classes/PageCoordinatorDataSource.html#/s:12XCoordinator25PageCoordinatorDataSourceC5pagesSaySo16UIViewControllerCGvp":{"name":"pages","abstract":"

The pages of the UIPageViewController in sequential order.

","parent_name":"PageCoordinatorDataSource"},"Classes/PageCoordinatorDataSource.html#/s:12XCoordinator25PageCoordinatorDataSourceC4loopSbvp":{"name":"loop","abstract":"

Whether or not the pages of the UIPageViewController should be in a loop,","parent_name":"PageCoordinatorDataSource"},"Classes/PageCoordinatorDataSource.html#/s:12XCoordinator25PageCoordinatorDataSourceC5pages4loopACSaySo16UIViewControllerCG_Sbtcfc":{"name":"init(pages:loop:)","abstract":"

Creates a PageCoordinatorDataSource with the given pages and looping capabilities.

","parent_name":"PageCoordinatorDataSource"},"Classes/PageCoordinatorDataSource.html#/c:@M@XCoordinator@objc(cs)PageCoordinatorDataSource(im)presentationCountForPageViewController:":{"name":"presentationCount(for:)","abstract":"

See UIPageViewControllerDataSource","parent_name":"PageCoordinatorDataSource"},"Classes/PageCoordinatorDataSource.html#/c:@M@XCoordinator@objc(cs)PageCoordinatorDataSource(im)presentationIndexForPageViewController:":{"name":"presentationIndex(for:)","abstract":"

See UIPageViewControllerDataSource","parent_name":"PageCoordinatorDataSource"},"Classes/PageCoordinatorDataSource.html#/c:@M@XCoordinator@objc(cs)PageCoordinatorDataSource(im)pageViewController:viewControllerBeforeViewController:":{"name":"pageViewController(_:viewControllerBefore:)","abstract":"

See UIPageViewControllerDataSource","parent_name":"PageCoordinatorDataSource"},"Classes/PageCoordinatorDataSource.html#/c:@M@XCoordinator@objc(cs)PageCoordinatorDataSource(im)pageViewController:viewControllerAfterViewController:":{"name":"pageViewController(_:viewControllerAfter:)","abstract":"

See UIPageViewControllerDataSource","parent_name":"PageCoordinatorDataSource"},"Classes/PageCoordinator.html#/s:12XCoordinator15PageCoordinatorC10dataSourceSo024UIPageViewControllerDataE0_pvp":{"name":"dataSource","abstract":"

The dataSource of the rootViewController.

","parent_name":"PageCoordinator"},"Classes/PageCoordinator.html#/s:12XCoordinator15PageCoordinatorC18rootViewController5pages4loop3set9directionACyxGSo06UIPageeF0C_SayAA11Presentable_pGSbAaL_pSgSo0keF19NavigationDirectionVtcfc":{"name":"init(rootViewController:pages:loop:set:direction:)","abstract":"

Creates a PageCoordinator with several sequential (potentially looping) pages.

","parent_name":"PageCoordinator"},"Classes/PageCoordinator.html#/s:12XCoordinator15PageCoordinatorC18rootViewController10dataSource3set9directionACyxGSo06UIPageeF0C_So0kef4DataH0_pAA11Presentable_pSo0keF19NavigationDirectionVtcfc":{"name":"init(rootViewController:dataSource:set:direction:)","abstract":"

Creates a PageCoordinator with a custom dataSource.","parent_name":"PageCoordinator"},"Classes/NavigationCoordinator.html#/s:12XCoordinator21NavigationCoordinatorC17animationDelegateAA0b9AnimationE0Cvp":{"name":"animationDelegate","abstract":"

The animation delegate controlling the rootViewController’s transition animations.","parent_name":"NavigationCoordinator"},"Classes/NavigationCoordinator.html#/s:12XCoordinator21NavigationCoordinatorC8delegateSo30UINavigationControllerDelegate_pSgvp":{"name":"delegate","abstract":"

This represents a fallback-delegate to be notified about navigation controller events.","parent_name":"NavigationCoordinator"},"Classes/NavigationCoordinator.html#/s:12XCoordinator21NavigationCoordinatorC18rootViewController12initialRouteACyxGSo012UINavigationF0C_xSgtcfc":{"name":"init(rootViewController:initialRoute:)","abstract":"

Creates a NavigationCoordinator and optionally triggers an initial route.

","parent_name":"NavigationCoordinator"},"Classes/NavigationCoordinator.html#/s:12XCoordinator21NavigationCoordinatorC18rootViewController0D0ACyxGSo012UINavigationF0C_AA11Presentable_ptcfc":{"name":"init(rootViewController:root:)","abstract":"

Creates a NavigationCoordinator and pushes a presentable onto the navigation stack right away.

","parent_name":"NavigationCoordinator"},"Classes/NavigationAnimationDelegate.html#/s:12XCoordinator27NavigationAnimationDelegateC17velocityThreshold12CoreGraphics7CGFloatVvp":{"name":"velocityThreshold","abstract":"

The velocity threshold needed for the interactive pop transition to succeed

","parent_name":"NavigationAnimationDelegate"},"Classes/NavigationAnimationDelegate.html#/s:12XCoordinator27NavigationAnimationDelegateC27transitionProgressThreshold12CoreGraphics7CGFloatVvp":{"name":"transitionProgressThreshold","abstract":"

The transition progress threshold for the interactive pop transition to succeed

","parent_name":"NavigationAnimationDelegate"},"Classes/NavigationAnimationDelegate.html#/c:@CM@XCoordinator@objc(cs)NavigationAnimationDelegate(im)navigationController:interactionControllerForAnimationController:":{"name":"navigationController(_:interactionControllerFor:)","abstract":"

See UINavigationControllerDelegate documentation","parent_name":"NavigationAnimationDelegate"},"Classes/NavigationAnimationDelegate.html#/c:@CM@XCoordinator@objc(cs)NavigationAnimationDelegate(im)navigationController:animationControllerForOperation:fromViewController:toViewController:":{"name":"navigationController(_:animationControllerFor:from:to:)","abstract":"

See UINavigationControllerDelegate documentation","parent_name":"NavigationAnimationDelegate"},"Classes/NavigationAnimationDelegate.html#/c:@CM@XCoordinator@objc(cs)NavigationAnimationDelegate(im)navigationController:didShowViewController:animated:":{"name":"navigationController(_:didShow:animated:)","abstract":"

See UINavigationControllerDelegate documentation","parent_name":"NavigationAnimationDelegate"},"Classes/NavigationAnimationDelegate.html#/c:@CM@XCoordinator@objc(cs)NavigationAnimationDelegate(im)navigationController:willShowViewController:animated:":{"name":"navigationController(_:willShow:animated:)","abstract":"

See UINavigationControllerDelegate documentation","parent_name":"NavigationAnimationDelegate"},"Classes/NavigationAnimationDelegate.html#/c:@CM@XCoordinator@objc(cs)NavigationAnimationDelegate(im)gestureRecognizerShouldBegin:":{"name":"gestureRecognizerShouldBegin(_:)","abstract":"

See UIGestureRecognizerDelegate documentation","parent_name":"NavigationAnimationDelegate"},"Classes/NavigationAnimationDelegate.html#/c:@CM@XCoordinator@objc(cs)NavigationAnimationDelegate(im)handleInteractivePopGestureRecognizer:":{"name":"handleInteractivePopGestureRecognizer(_:)","abstract":"

This method handles changes of the navigation controller’s interactivePopGestureRecognizer.

","parent_name":"NavigationAnimationDelegate"},"Classes/NavigationAnimationDelegate.html#/s:12XCoordinator27NavigationAnimationDelegateC25setupPopGestureRecognizer3forySo22UINavigationControllerC_tF":{"name":"setupPopGestureRecognizer(for:)","abstract":"

This method sets up the interactivePopGestureRecognizer of the navigation controller","parent_name":"NavigationAnimationDelegate"},"Classes/InterruptibleTransitionAnimation.html#/s:12XCoordinator32InterruptibleTransitionAnimationC8duration16generateAnimator0F21InteractionControllerACSd_So25UIViewImplicitlyAnimating_pSo0jI20ContextTransitioning_pcAA013PercentDrivenhI0_pSgyctcfc":{"name":"init(duration:generateAnimator:generateInteractionController:)","abstract":"

Creates an interruptible transition animation based on duration, an animator generator closure","parent_name":"InterruptibleTransitionAnimation"},"Classes/InterruptibleTransitionAnimation.html#/s:12XCoordinator32InterruptibleTransitionAnimationC8duration16generateAnimatorACSd_So25UIViewImplicitlyAnimating_pSo0H30ControllerContextTransitioning_pctcfc":{"name":"init(duration:generateAnimator:)","abstract":"

Creates an interruptible transition animation based on duration and an animator generator closure.

","parent_name":"InterruptibleTransitionAnimation"},"Classes/InterruptibleTransitionAnimation.html#/s:12XCoordinator32InterruptibleTransitionAnimationC08generateB8Animator5usingSo25UIViewImplicitlyAnimating_pSo0H30ControllerContextTransitioning_p_tF":{"name":"generateInterruptibleAnimator(using:)","abstract":"

Generates an interruptible animator based on the transitionContext.","parent_name":"InterruptibleTransitionAnimation"},"Classes/InterruptibleTransitionAnimation.html#/c:@M@XCoordinator@objc(cs)InterruptibleTransitionAnimation(im)animateTransition:":{"name":"animateTransition(using:)","abstract":"

See UIViewControllerAnimatedTransitioning","parent_name":"InterruptibleTransitionAnimation"},"Classes/InterruptibleTransitionAnimation.html#/c:@M@XCoordinator@objc(cs)InterruptibleTransitionAnimation(im)interruptibleAnimatorForTransition:":{"name":"interruptibleAnimator(using:)","abstract":"

See UIViewControllerAnimatedTransitioning","parent_name":"InterruptibleTransitionAnimation"},"Classes/InteractiveTransitionAnimation.html#/s:12XCoordinator19TransitionAnimationP21interactionControllerAA024PercentDrivenInteractionE0_pSgvp":{"name":"interactionController","parent_name":"InteractiveTransitionAnimation"},"Classes/InteractiveTransitionAnimation.html#/s:12XCoordinator30InteractiveTransitionAnimationC8duration10transition29generateInteractionControllerACSd_ySo06UIViewI20ContextTransitioning_pcAA013PercentDrivenhI0_pSgyctcfc":{"name":"init(duration:transition:generateInteractionController:)","abstract":"

Creates an InteractiveTransitionAnimation with a duration, an animation closure and a closure to","parent_name":"InteractiveTransitionAnimation"},"Classes/InteractiveTransitionAnimation.html#/s:12XCoordinator30InteractiveTransitionAnimationC8duration10transitionACSd_ySo36UIViewControllerContextTransitioning_pctcfc":{"name":"init(duration:transition:)","abstract":"

Convenience initializer for init(duration:transition:generateInteractionController:).","parent_name":"InteractiveTransitionAnimation"},"Classes/InteractiveTransitionAnimation.html#/s:12XCoordinator30InteractiveTransitionAnimationC010transitionD029generateInteractionControllerAcA06StaticcD0C_AA013PercentDrivengH0_pSgyctcfc":{"name":"init(transitionAnimation:generateInteractionController:)","abstract":"

Convenience initializer for init(duration:transition:generateInteractionController:).","parent_name":"InteractiveTransitionAnimation"},"Classes/InteractiveTransitionAnimation.html#/s:12XCoordinator30InteractiveTransitionAnimationC010transitionD0AcA06StaticcD0C_tcfc":{"name":"init(transitionAnimation:)","abstract":"

Convenience initializer for init(duration:transition:).","parent_name":"InteractiveTransitionAnimation"},"Classes/InteractiveTransitionAnimation.html#/c:@M@XCoordinator@objc(cs)InteractiveTransitionAnimation(im)transitionDuration:":{"name":"transitionDuration(using:)","abstract":"

See UIViewControllerAnimatedTransitioning","parent_name":"InteractiveTransitionAnimation"},"Classes/InteractiveTransitionAnimation.html#/c:@M@XCoordinator@objc(cs)InteractiveTransitionAnimation(im)animateTransition:":{"name":"animateTransition(using:)","abstract":"

See UIViewControllerAnimatedTransitioning","parent_name":"InteractiveTransitionAnimation"},"Classes/InteractiveTransitionAnimation.html#/s:12XCoordinator30InteractiveTransitionAnimationC29generateInteractionControllerAA013PercentDrivenfG0_pSgyF":{"name":"generateInteractionController()","abstract":"

This method is used to generate an applicable interaction controller.

","parent_name":"InteractiveTransitionAnimation"},"Classes/InteractiveTransitionAnimation.html#/s:12XCoordinator30InteractiveTransitionAnimationC5startyyF":{"name":"start()","abstract":"

Starts the transition animation by generating an interaction controller.

","parent_name":"InteractiveTransitionAnimation"},"Classes/InteractiveTransitionAnimation.html#/s:12XCoordinator30InteractiveTransitionAnimationC7cleanupyyF":{"name":"cleanup()","abstract":"

Ends the transition animation by deleting the interaction controller.

","parent_name":"InteractiveTransitionAnimation"},"Classes/BasicCoordinator/InitialLoadingType.html#/s:12XCoordinator16BasicCoordinatorC18InitialLoadingTypeO11immediatelyyAEyxq__GAGmAA5RouteRzAA18TransitionProtocolR_r0_lF":{"name":"immediately","abstract":"

The initial route is triggered before the coordinator is made visible (i.e. on initialization).

","parent_name":"InitialLoadingType"},"Classes/BasicCoordinator/InitialLoadingType.html#/s:12XCoordinator16BasicCoordinatorC18InitialLoadingTypeO9presentedyAEyxq__GAGmAA5RouteRzAA18TransitionProtocolR_r0_lF":{"name":"presented","abstract":"

The initial route is triggered after the coordinator is made visible.

","parent_name":"InitialLoadingType"},"Classes/BasicCoordinator/InitialLoadingType.html":{"name":"InitialLoadingType","abstract":"

InitialLoadingType differentiates between different points in time when the initital route is to","parent_name":"BasicCoordinator"},"Classes/BasicCoordinator.html#/s:12XCoordinator16BasicCoordinatorC18rootViewController12initialRoute0G11LoadingType17prepareTransitionACyxq_G04RooteF0Qy__xSgAC07InitialiJ0Oyxq__Gq_xcSgtcfc":{"name":"init(rootViewController:initialRoute:initialLoadingType:prepareTransition:)","abstract":"

Creates a BasicCoordinator.

","parent_name":"BasicCoordinator"},"Classes/BasicCoordinator.html#/s:12XCoordinator16BasicCoordinatorC9presented4fromyAA11Presentable_pSg_tF":{"name":"presented(from:)","abstract":"

This method is called whenever the BasicCoordinator is shown to the user.

","parent_name":"BasicCoordinator"},"Classes/BasicCoordinator.html#/s:12XCoordinator16BasicCoordinatorC17prepareTransition3forq_x_tF":{"name":"prepareTransition(for:)","parent_name":"BasicCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator15BaseCoordinatorC8childrenSayAA11Presentable_pGvp":{"name":"children","abstract":"

The child coordinators that are currently in the view hierarchy.","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator19TransitionPerformerP18rootViewController0B4Type_04RooteF0QZvp":{"name":"rootViewController","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator11PresentableP14viewControllerSo06UIViewD0CSgvp":{"name":"viewController","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator15BaseCoordinatorC18rootViewController12initialRouteACyxq_G04RooteF0Qy__xSgtcfc":{"name":"init(rootViewController:initialRoute:)","abstract":"

This initializer trigger a route before the coordinator is made visible.

","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator15BaseCoordinatorC18rootViewController17initialTransitionACyxq_G04RooteF0Qy__q_Sgtcfc":{"name":"init(rootViewController:initialTransition:)","abstract":"

This initializer performs a transition before the coordinator is made visible.

","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator11PresentableP9presented4fromyAaB_pSg_tF":{"name":"presented(from:)","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator11CoordinatorP22removeChildrenIfNeededyyF":{"name":"removeChildrenIfNeeded()","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator11CoordinatorP8addChildyyAA11Presentable_pF":{"name":"addChild(_:)","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator11CoordinatorP11removeChildyyAA11Presentable_pF":{"name":"removeChild(_:)","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator15BaseCoordinatorC17prepareTransition3forq_x_tF":{"name":"prepareTransition(for:)","abstract":"

This method prepares transitions for routes.","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator11PresentableP14registerParentyyAaB_XlF":{"name":"registerParent(_:)","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator15BaseCoordinatorC18RootViewControllera":{"name":"RootViewController","abstract":"

Shortcut for BaseCoordinator.TransitionType.RootViewController

","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator15BaseCoordinatorC29registerInteractiveTransition3for11triggeredBy7handler10completionyx_qd__yqd___AA0F9Animation_pSgyXEtcyycSgtSo19UIGestureRecognizerCRbd__lF":{"name":"registerInteractiveTransition(for:triggeredBy:handler:completion:)","abstract":"

Register an interactive transition triggered by a gesture recognizer.

","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator15BaseCoordinatorC29registerInteractiveTransition3for11triggeredBy8progress12shouldFinish10completionyx_qd__12CoreGraphics7CGFloatVqd__cSbqd__cyycSgtSo19UIGestureRecognizerCRbd__lF":{"name":"registerInteractiveTransition(for:triggeredBy:progress:shouldFinish:completion:)","abstract":"

Register an interactive transition triggered by a gesture recognizer.

","parent_name":"BaseCoordinator"},"Classes/BaseCoordinator.html#/s:12XCoordinator15BaseCoordinatorC32unregisterInteractiveTransitions11triggeredByySo19UIGestureRecognizerC_tF":{"name":"unregisterInteractiveTransitions(triggeredBy:)","abstract":"

Unregisters a previously registered interactive transition.

","parent_name":"BaseCoordinator"},"Classes/AnyTransitionPerformer.html#/s:12XCoordinator11PresentableP14viewControllerSo06UIViewD0CSgvp":{"name":"viewController","parent_name":"AnyTransitionPerformer"},"Classes/AnyTransitionPerformer.html#/s:12XCoordinator19TransitionPerformerP18rootViewController0B4Type_04RooteF0QZvp":{"name":"rootViewController","parent_name":"AnyTransitionPerformer"},"Classes/AnyTransitionPerformer.html#/s:12XCoordinator11PresentableP9presented4fromyAaB_pSg_tF":{"name":"presented(from:)","parent_name":"AnyTransitionPerformer"},"Classes/AnyTransitionPerformer.html#/s:12XCoordinator19TransitionPerformerP07performB0_4with10completiony0B4TypeQz_AA0B7OptionsVyycSgtF":{"name":"performTransition(_:with:completion:)","parent_name":"AnyTransitionPerformer"},"Classes/AnyCoordinator.html#/s:12XCoordinator14AnyCoordinatorCyACyxq_Gqd__c9RouteTypeQyd__Rsz010TransitionE0Qyd__Rs_AA0C0Rd__lufc":{"name":"init(_:)","abstract":"

Creates a type-erased Coordinator for a specific coordinator.

","parent_name":"AnyCoordinator"},"Classes/AnyCoordinator.html#/s:12XCoordinator19TransitionPerformerP18rootViewController0B4Type_04RooteF0QZvp":{"name":"rootViewController","parent_name":"AnyCoordinator"},"Classes/AnyCoordinator.html#/s:12XCoordinator11PresentableP14viewControllerSo06UIViewD0CSgvp":{"name":"viewController","parent_name":"AnyCoordinator"},"Classes/AnyCoordinator.html#/s:12XCoordinator14AnyCoordinatorC17prepareTransition3forq_x_tF":{"name":"prepareTransition(for:)","abstract":"

Prepare and return transitions for a given route.

","parent_name":"AnyCoordinator"},"Classes/AnyCoordinator.html#/s:12XCoordinator11PresentableP9presented4fromyAaB_pSg_tF":{"name":"presented(from:)","parent_name":"AnyCoordinator"},"Classes/AnyCoordinator.html#/s:12XCoordinator11PresentableP14registerParentyyAaB_XlF":{"name":"registerParent(_:)","parent_name":"AnyCoordinator"},"Classes/AnyCoordinator.html#/s:12XCoordinator11PresentableP7setRoot3forySo8UIWindowC_tF":{"name":"setRoot(for:)","parent_name":"AnyCoordinator"},"Classes/AnyCoordinator.html#/s:12XCoordinator11CoordinatorP8addChildyyAA11Presentable_pF":{"name":"addChild(_:)","parent_name":"AnyCoordinator"},"Classes/AnyCoordinator.html#/s:12XCoordinator11CoordinatorP11removeChildyyAA11Presentable_pF":{"name":"removeChild(_:)","parent_name":"AnyCoordinator"},"Classes/AnyCoordinator.html#/s:12XCoordinator11CoordinatorP22removeChildrenIfNeededyyF":{"name":"removeChildrenIfNeeded()","parent_name":"AnyCoordinator"},"Classes/Animation.html#/s:12XCoordinator9AnimationC7defaultACvpZ":{"name":"default","abstract":"

Use Animation.default to override currently set animations","parent_name":"Animation"},"Classes/Animation.html#/s:12XCoordinator9AnimationC012presentationB0AA010TransitionB0_pSgvp":{"name":"presentationAnimation","abstract":"

The transition animation performed when transitioning to a presentable.

","parent_name":"Animation"},"Classes/Animation.html#/s:12XCoordinator9AnimationC09dismissalB0AA010TransitionB0_pSgvp":{"name":"dismissalAnimation","abstract":"

The transition animation performed when transitioning away from a presentable.

","parent_name":"Animation"},"Classes/Animation.html#/s:12XCoordinator9AnimationC12presentation9dismissalAcA010TransitionB0_pSg_AGtcfc":{"name":"init(presentation:dismissal:)","abstract":"

Creates an Animation object containing a presentation and a dismissal animation.

","parent_name":"Animation"},"Classes/Animation.html#/c:@CM@XCoordinator@objc(cs)Animation(im)animationControllerForPresentedController:presentingController:sourceController:":{"name":"animationController(forPresented:presenting:source:)","abstract":"

See UIViewControllerTransitioningDelegate","parent_name":"Animation"},"Classes/Animation.html#/c:@CM@XCoordinator@objc(cs)Animation(im)animationControllerForDismissedController:":{"name":"animationController(forDismissed:)","abstract":"

See UIViewControllerTransitioningDelegate","parent_name":"Animation"},"Classes/Animation.html#/c:@CM@XCoordinator@objc(cs)Animation(im)interactionControllerForPresentation:":{"name":"interactionControllerForPresentation(using:)","abstract":"

See UIViewControllerTransitioningDelegate","parent_name":"Animation"},"Classes/Animation.html#/c:@CM@XCoordinator@objc(cs)Animation(im)interactionControllerForDismissal:":{"name":"interactionControllerForDismissal(using:)","abstract":"

See UIViewControllerTransitioningDelegate","parent_name":"Animation"},"Classes/Animation.html":{"name":"Animation","abstract":"

Animation is used to set presentation and dismissal animations for presentables.

"},"Classes/AnyCoordinator.html":{"name":"AnyCoordinator","abstract":"

AnyCoordinator is a type-erased Coordinator (RouteType & TransitionType) and"},"Classes/AnyTransitionPerformer.html":{"name":"AnyTransitionPerformer","abstract":"

AnyTransitionPerformer can be used as an abstraction from a specific TransitionPerformer implementation"},"Classes/BaseCoordinator.html":{"name":"BaseCoordinator","abstract":"

BaseCoordinator can (and is encouraged to) be used as a superclass for any custom implementation of a coordinator.

"},"Classes/BasicCoordinator.html":{"name":"BasicCoordinator","abstract":"

BasicCoordinator is a coordinator class that can be used without subclassing.

"},"Classes/InteractiveTransitionAnimation.html":{"name":"InteractiveTransitionAnimation","abstract":"

InteractiveTransitionAnimation provides a simple interface to create interactive transition animations.

"},"Classes/InterruptibleTransitionAnimation.html":{"name":"InterruptibleTransitionAnimation","abstract":"

Use InterruptibleTransitionAnimation to define interactive transitions based on the"},"Classes/NavigationAnimationDelegate.html":{"name":"NavigationAnimationDelegate","abstract":"

NavigationAnimationDelegate is used as the delegate of a NavigationCoordinator’s rootViewController"},"Classes/NavigationCoordinator.html":{"name":"NavigationCoordinator","abstract":"

NavigationCoordinator acts as a base class for custom coordinators with a UINavigationController"},"Classes/PageCoordinator.html":{"name":"PageCoordinator","abstract":"

PageCoordinator provides a base class for your custom coordinator with a UIPageViewController rootViewController.

"},"Classes/PageCoordinatorDataSource.html":{"name":"PageCoordinatorDataSource","abstract":"

PageCoordinatorDataSource is a"},"Classes/RedirectionRouter.html":{"name":"RedirectionRouter","abstract":"

RedirectionRouters can be used to extract routes into different route types."},"Classes/SplitCoordinator.html":{"name":"SplitCoordinator","abstract":"

SplitCoordinator can be used as a basis for a coordinator with a rootViewController of type"},"Classes/StaticTransitionAnimation.html":{"name":"StaticTransitionAnimation","abstract":"

StaticTransitionAnimation can be used to realize static transition animations.

"},"Classes/StrongRouter.html":{"name":"StrongRouter","abstract":"

StrongRouter is a type-erasure of a given Router object and, therefore, can be used as an abstraction from a specific Router"},"Classes/TabBarAnimationDelegate.html":{"name":"TabBarAnimationDelegate","abstract":"

TabBarAnimationDelegate is used as the delegate of a TabBarCoordinator’s rootViewController"},"Classes/TabBarCoordinator.html":{"name":"TabBarCoordinator","abstract":"

Use a TabBarCoordinator to coordinate a flow where a UITabbarController serves as a rootViewController."},"Classes/ViewCoordinator.html":{"name":"ViewCoordinator","abstract":"

ViewCoordinator is a base class for custom coordinators with a UIViewController rootViewController.

"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Extensions.html":{"name":"Extensions","abstract":"

The following extensions are available globally.

"},"Protocols.html":{"name":"Protocols","abstract":"

The following protocols are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"},"Typealiases.html":{"name":"Type Aliases","abstract":"

The following type aliases are available globally.

"}} \ No newline at end of file diff --git a/docs/undocumented.json b/docs/undocumented.json deleted file mode 100644 index efe446d6..00000000 --- a/docs/undocumented.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "warnings": [ - - ], - "source_directory": "/Users/pauljohanneskraft/Documents/QuickBirdStudios/Frameworks/XCoordinator" -} \ No newline at end of file diff --git a/scripts/build.sh b/scripts/build.sh deleted file mode 100755 index 2c719037..00000000 --- a/scripts/build.sh +++ /dev/null @@ -1,11 +0,0 @@ -#!/bin/sh - -# Preparation - -set -o pipefail - -# Execution - -swift build \ - -Xswiftc "-sdk" -Xswiftc "`xcrun --sdk iphonesimulator --show-sdk-path`" \ - -Xswiftc "-target" -Xswiftc "x86_64-apple-ios13.0-simulator" diff --git a/scripts/check_docs.sh b/scripts/check_docs.sh deleted file mode 100755 index 8692fabe..00000000 --- a/scripts/check_docs.sh +++ /dev/null @@ -1,21 +0,0 @@ - -# Preparation - -cd "$( dirname "$0" )" -undocumented_file_url="../docs/undocumented.json" - -# Execution - -./docs.sh - -if [ -z "$(git status --untracked-files=no --porcelain)" ]; then - if [[ $(wc -l <$undocumented_file_url) -ge 2 ]]; then - echo "$(cat $undocumented_file_url)" - exit 1 - else - exit 0 - fi -else - echo "$(git status)\n$(git diff)" - exit 1 -fi diff --git a/scripts/docs.sh b/scripts/docs.sh deleted file mode 100755 index b2fa21dc..00000000 --- a/scripts/docs.sh +++ /dev/null @@ -1,22 +0,0 @@ -#!/bin/sh - -# Preparation - -cd "$( dirname "$0" )" - -# Constants - -jazzy_file_url="tmp_jazzy.json" - -# Execution - -cd .. -sourcekitten doc --spm-module XCoordinator -- \ - -Xswiftc "-sdk" -Xswiftc "`xcrun --sdk iphonesimulator --show-sdk-path`" \ - -Xswiftc "-target" -Xswiftc "x86_64-apple-ios13.0-simulator" \ - > $jazzy_file_url -jazzy --sourcekitten-sourcefile $jazzy_file_url - -# Cleanup - -rm $jazzy_file_url