Classes Reference


                    
                    
                    Router

Object responsible for performing navigation to concrete routes, as well as keeping references to root view provider and view finder.

Declaration

Swift

open class Router


                    
                    
                    BaseTransition

Base class for transition objects.

Declaration

Swift

open class BaseTransition


                    
                    
                    CurrentlyVisibleViewFinder

Class, capable of finding currently visible view, using recursive search through UIViewController, UINavigationController and UITabBarController APIs.

Declaration

Swift

open class CurrentlyVisibleViewFinder : ViewFinder


                    
                    
                    SplitViewCurrentlyVisibleViewFinder

CurrentlyVisibleViewFinder that proritizes either master or detail view controller in split view controllers. Please note that this ViewFinder should only be used for iPad interfaces that do not have collapsed UISplitViewControllers. If UISplitViewController is collapsed, it’s viewControllers property only returns one of two(master,detail) view controllers and therefore it’s impossible to know if one of those is a master or a detail.

Declaration

Swift

open class SplitViewCurrentlyVisibleViewFinder : CurrentlyVisibleViewFinder


                    
                    
                    PushNavigationTransition

Class, that encapsulates UINavigationController.pushViewController(_:animated:) method call as a transition.

Declaration

Swift

open class PushNavigationTransition : BaseTransition, ViewTransition


                    
                    
                    PopNavigationTransition

Class, that encapsulates UINavigationController.popViewController(_:animated:) method call as a transition.

Declaration

Swift

open class PopNavigationTransition : BaseTransition, ViewTransition


                    
                    
                    ReplaceNavigationTransition

Class, that encapsulates UINavigationController.setViewControllers(_:animated:) method call as a transition.

Declaration

Swift

open class ReplaceNavigationTransition : BaseTransition, ViewTransition


                    
                    
                    PopToRootNavigationTransition

Undocumented

Declaration

Swift

open class PopToRootNavigationTransition : BaseTransition, ViewTransition


                    
                    
                    NavigationEmbeddingBuilder

Builder for UINavigationController instance with array of views.

Declaration

Swift

open class NavigationEmbeddingBuilder : ViewControllerBuilder


                    
                    
                    NavigationSingleViewEmbeddingBuilder

Builder for UINavigationController instance with a single embedded view. This builder keeps Context the same as Context of embedded view builder, thus allowing building a combination of those by passing embedded view Context.

Declaration

Swift

open class NavigationSingleViewEmbeddingBuilder<T> : ViewControllerBuilder where T : ViewControllerBuilder


                    
                    
                    PresentationTransition

Class, that encapsulates UIViewController.present(_:animated:) method call as a transition.

Declaration

Swift

open class PresentationTransition : BaseTransition, ViewTransition


                    
                    
                    DismissTransition

Class, that encapsulates UIViewController.dismiss(animated:) method call as transition

Declaration

Swift

open class DismissTransition : BaseTransition, ViewTransition


                    
                    
                    RootViewTransition

Class, that implements transition for UIWindow.rootViewController.

Declaration

Swift

open class RootViewTransition : ViewTransition


                    
                    
                    Route

Type, that is responsible for performing routing between views.

Declaration

Swift

open class Route<Builder, Transition> : Routable where Builder : ViewControllerBuilder, Transition : ViewTransition


                    
                    
                    UpdatingRoute

Subclass of Route, that allows view to be updated instead of creating a new one to transition to.

Declaration

Swift

open class UpdatingRoute<Finder: UpdatableViewFinder, Builder: ViewControllerBuilder, Transition: ViewTransition>: Route<Builder, Transition>
    where Builder.ViewType: ContextUpdatable,
        Builder.Context == Finder.ViewType.Context,
        Finder.Context == Builder.Context,
        Finder.ViewType == Builder.ViewType


                    
                    
                    ChainableRoute

Routable type, that can be used to chain multiple Route objects. This is useful, for example, if you want to hide one View, and then immediately after hiding completes, show a different one.

Declaration

Swift

open class ChainableRoute<T, U> : Routable where T : Routable, U : Routable


                    
                    
                    SplitViewBuilder

Builder for UISplitViewController instance.

Declaration

Swift

open class SplitViewBuilder<MasterBuilder, DetailBuilder> : ViewControllerBuilder where MasterBuilder : ViewControllerBuilder, DetailBuilder : ViewControllerBuilder


                    
                    
                    TabBarEmbeddingBuilder

Builder for UITabBarController instance.

Declaration

Swift

open class TabBarEmbeddingBuilder : ViewControllerBuilder


                    
                    
                    CurrentlyVisibleUpdatableViewFinder

UpdatableViewFinder type that searches current view hierarchy to find view, that can be updated using Context. Uses CurrentlyVisibleViewFinder to search view hierarchy for currently visible view.

Declaration

Swift

open class CurrentlyVisibleUpdatableViewFinder<T> : UpdatableViewFinder where T : ViewController, T : ContextUpdatable


                    
                    
                    NonBuildableView

View, that should not be built. Can be used for transitions, that hide currently visible view and do not require a new view to be built. For example - PopNavigationTransition, or DismissTransition.

Declaration

Swift

open class NonBuildableView : ViewController


                    
                    
                    NonBuilder

Builder, that is incapable of building a view and asserts when asked to do so. Can be used for transitions, that hide currently visible view and do not require a new view to be built. For example - PopNavigationTransition, or DismissTransition.

Declaration

Swift

open class NonBuilder : ViewControllerBuilder


                    
                    
                    InstanceViewBuilder

Class, that can be used to build a View using provided closure.

Declaration

Swift

open class InstanceViewBuilder<T> : ViewControllerBuilder where T : ViewController