ControllerFlow

@MainActor
public final class ControllerFlow<DestinationType, TabType, ContentType> : NSObject, ControllerFlowable, UITabBarControllerDelegate where DestinationType : RoutableDestinations, TabType : TabTypeable, ContentType : ContentTypeable

extension ControllerFlow: DestinationInterfaceCoordinatorDelegate

A concrete Flow class designed to be used to manage Destinations flows within the UIKit framework. In most cases creating a custom Flow object is unnecessary, and this class can be used as-is in your UIKit-based app.

DestinationType
An enum which defines all routable Destinations in the app.
Declaration
Swift

public typealias DestinationType = DestinationType
TabType
An enum which defines types of tabs in a tab bar.
Declaration
Swift

public typealias TabType = TabType
ContentType
An enum which defines the types of content that are able to be sent through Destinations.
Declaration
Swift

public typealias ContentType = ContentType


                    
                    
                    InterfaceCoordinator

Declaration

Swift

public typealias InterfaceCoordinator = DestinationUIKitCoordinator


                    
                    
                    activeDestinations

Declaration

Swift

@MainActor
public var activeDestinations: [any Destinationable<DestinationType, ContentType, TabType>]


                    
                    
                    currentDestination

Declaration

Swift

@MainActor
public var currentDestination: (any Destinationable<DestinationType, ContentType, TabType>)?


                    
                    
                    destinationProviders

Declaration

Swift

@MainActor
public var destinationProviders: [DestinationType : any ControllerDestinationProviding]


                    
                    
                    uiCoordinator

Declaration

Swift

@MainActor
public var uiCoordinator: DestinationUIKitCoordinator?


                    
                    
                    rootDestination

Declaration

Swift

@MainActor
public var rootDestination: (any Destinationable<DestinationType, ContentType, TabType>)?


                    
                    
                    destinationQueue

Declaration

Swift

@MainActor
public var destinationQueue: [DestinationPresentation<DestinationType, ContentType, TabType>]


                    
                    
                    isPresentingDestinationPath

Declaration

Swift

@MainActor
public var isPresentingDestinationPath: Bool


                    
                    
                    startingDestination

The starting Destination in the Flow.

Declaration

Swift

@MainActor
public var startingDestination: DestinationPresentation<DestinationType, ContentType, TabType>?


                    
                    
                    init(destinationProviders:startingDestination:routesToIgnore:)

The initializer.

Declaration

Swift

@MainActor
public init(destinationProviders: [DestinationType : any ControllerDestinationProviding], startingDestination: DestinationPresentation<DestinationType, ContentType, TabType>, routesToIgnore: [DestinationType]? = nil)

Parameters

`destinationProviders`	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.
`startingDestination`	The starting Destination.
`routesToIgnore`	An optional list of routes to ignore when checking for Provider assignments.

start()
Declaration
Swift

@MainActor public func start()


                    
                    
                    assignBaseController(_:)

Declaration

Swift

@MainActor
public func assignBaseController(_ baseController: any ControllerDestinationInterfacing)


                    
                    
                    destination(for:)

Declaration

Swift

@MainActor
public func destination(for configuration: DestinationPresentation<DestinationType, ContentType, TabType>) -> (any ControllerDestinationable<DestinationType, ContentType, TabType>)?


                    
                    
                    presentDestination(configuration:)

Declaration

Swift

@discardableResult
@MainActor
public func presentDestination(configuration: DestinationPresentation<DestinationType, ContentType, TabType>) -> (any ControllerDestinationable<DestinationType, ContentType, TabType>)?


                    
                    
                    presentationCompletionClosure(for:destination:)

Declaration

Swift

@MainActor
public func presentationCompletionClosure(for configuration: DestinationPresentation<DestinationType, ContentType, TabType>, destination: (any Destinationable<DestinationType, ContentType, TabType>)? = nil) -> PresentationCompletionClosure?

UITabBarControllerDelegate methods


                    
                    
                    tabBarController(_:didSelect:)

UITabBarControllerDelegate delegate method

Declaration

Swift

@MainActor
public func tabBarController(_ tabBarController: UITabBarController, didSelect viewController: UIViewController)


                    
                    
                    didRequestCurrentDestinationChange(newDestinationID:)

Declaration

Swift

@MainActor
public func didRequestCurrentDestinationChange(newDestinationID: UUID)