View on GitHub
ControllerFlowable
@MainActor
public protocol ControllerFlowable<PresentationConfiguration> : Flowable where Self.InterfaceCoordinator == DestinationUIKitCoordinator, Self.PresentationConfiguration == DestinationPresentation<Self.DestinationType, Self.ContentType, Self.TabType>, Self.PresentationType == DestinationPresentationType<DestinationPresentation<Self.DestinationType, Self.ContentType, Self.TabType>>This protocol represents a Flow which coordinates routing and navigation as a user moves through a UIKit-based app.
-
An enum which defines available Destination presentation types. Typically this is
DestinationPresentationType.Declaration
Swift
typealias PresentationType = DestinationPresentationType<PresentationConfiguration> -
A dictionary of Destination providers whose keys are an enum of Destination types. The Destination type represents the type of Destination each provider can provide.
Declaration
Swift
@MainActor var destinationProviders: [DestinationType : any ControllerDestinationProviding] { get set } -
Provides a Destination based on the provided configuration model.
Declaration
Swift
@MainActor func destination(for configuration: PresentationConfiguration) -> (any ControllerDestinationable<PresentationConfiguration>)?Parameters
configurationThe presentation configuration model describing the Destination to return.
Return Value
The requested Destination, if one was found or able to be built.
-
buildDestination(for:Default implementation) Builds and returns a new Destination based on the supplied configuration model.
Default Implementation
Declaration
Swift
@MainActor func buildDestination(for configuration: PresentationConfiguration) -> (any ControllerDestinationable<PresentationConfiguration>)?Parameters
configurationA presentation configuration model to build the Destination.
Return Value
The created Destination, if one could be built.
-
Presents a Destination based on the supplied configuration model.
Declaration
Swift
@discardableResult @MainActor func presentDestination(configuration: PresentationConfiguration) -> (any ControllerDestinationable<PresentationConfiguration>)?Parameters
configurationA presentation configuration model by which to find or build a Destination.
Return Value
The presented Destination, if one was found or created.
-
updateDestinationConfiguration(configuration:Default implementationdestination: ) Updates a presentation configuration model.
Default Implementation
Declaration
Swift
@MainActor func updateDestinationConfiguration(configuration: inout PresentationConfiguration, destination: inout some ControllerDestinationable<PresentationConfiguration>)Parameters
configurationA presentation configuration model to update.
destinationA Destination to update.
-
findTabBarInViewHierarchy(currentDestination:Default implementation) Finds the closest Destination in the view hierarchy whose interface is a
UITabBarController.Default Implementation
Declaration
Swift
@MainActor func findTabBarInViewHierarchy(currentDestination: any ControllerDestinationable) -> (any TabBarControllerDestinationable<PresentationConfiguration, TabType>)?Parameters
currentDestinationThe Destination to start searching at.
Return Value
Returns a Destination, if one was found.
-
findSplitViewInViewHierarchy(currentDestination:Default implementation) Finds the closest Destination in the view hierarchy whose interface is a
UISplitViewController.Default Implementation
Declaration
Swift
@MainActor func findSplitViewInViewHierarchy(currentDestination: any ControllerDestinationable) -> (any SplitViewControllerDestinationable<PresentationConfiguration>)?Parameters
currentDestinationThe Destination to start searching at.
Return Value
Returns a Destination, if one was found.
-
findNearestNavigatorInViewHierarchy(currentDestination:Default implementation) Finds the closest navigator in the view hierarchy to the provided Destination.
Default Implementation
Declaration
Swift
@MainActor func findNearestNavigatorInViewHierarchy(currentDestination: any ControllerDestinationable) -> (any NavigatingControllerDestinationable<PresentationConfiguration>)?Parameters
currentDestinationThe Destination to start searching at.
Return Value
Returns a navigator, if one was found.
-
Assigns a root controller to serve as the base controller of this Flow’s Destinations.
Declaration
Swift
@MainActor func assignRoot(rootController: any ControllerDestinationInterfacing)Parameters
rootControllerThe root controller.
-
presentNextDestinationInQueue()Extension methodDeclaration
Swift
@discardableResult @MainActor func presentNextDestinationInQueue() -> (any Destinationable<PresentationConfiguration>)? -
defaultSheetDismissalCompletionClosure(configuration:Extension method) Declaration
Swift
@MainActor func defaultSheetDismissalCompletionClosure(configuration: PresentationConfiguration) -> PresentationCompletionClosure? -
defaultNavigationBackCompletionClosure(configuration:Extension method) Declaration
Swift
@MainActor func defaultNavigationBackCompletionClosure(configuration: PresentationConfiguration) -> PresentationCompletionClosure?