Type Aliases
The following type aliases are available globally.
-
A closure which drives a custom SwiftUI Destination presentation.
Important
At the end of your custom presentation you must callcompletionClosure
, passing a Boolean for whether the presentation or setup succeeds or fails.Declaration
Swift
public typealias CustomViewPresentationClosure<DestinationPresentation: DestinationPresentationConfiguring> = ( _ destinationToPresent: (any ViewDestinationable<DestinationPresentation>)?, _ currentDestination: (any ViewDestinationable<DestinationPresentation>)?, _ parentOfCurrentDestination: (any ViewDestinationable)?, _ completionClosure: ((Bool) -> Void)?) -> Void
-
A closure which drives a custom UIKit Destination presentation.
Important
At the end of your custom presentation you must callcompletionClosure
, passing a Boolean for whether the presentation or setup succeeds or fails.Declaration
Swift
public typealias CustomControllerPresentationClosure<DestinationPresentation: DestinationPresentationConfiguring> = ( _ destinationToPresent: (any ControllerDestinationable<DestinationPresentation>)?, _ rootController: (any ControllerDestinationInterfacing)?, _ currentDestination: (any ControllerDestinationable)?, _ parentOfCurrentDestination: (any ControllerDestinationable)?, _ completionClosure: ((Bool) -> Void)?) -> Void
-
Generic closure to handle data source responses.
Declaration
Swift
public typealias DatasourceResponseClosure<T> = (_ result: Result<T, Error>) -> Void where T : Hashable
-
A closure which is called when a Destination should be removed from the Flow object managing the ecosystem, typically after it’s associated UI object is no longer being presented.
Declaration
Swift
public typealias RemoveDestinationFromFlowClosure = ((_ removalID: UUID) -> Void)
-
A closure that is activated when a Destination presentation has completed.
Declaration
Swift
public typealias PresentationCompletionClosure = ((_ didComplete: Bool) -> Void)
-
A closure run when a child Destination is removed from a
GroupedDestinationable
object.Declaration
Swift
public typealias GroupChildRemovedClosure = (_ destinationID: UUID) -> Void
-
A closure run when the current child Destination of a
GroupedDestinationable
has changed.Declaration
Swift
public typealias GroupCurrentDestinationChangedClosure = (_ destinationID: UUID?) -> Void
-
A typealias describing a SwiftUI-based
GroupedDestinationable
which also conforms toViewDestinationable
.Declaration
Swift
public typealias GroupedViewDestinationable<PresentationConfiguration> = GroupedDestinationable<PresentationConfiguration> & ViewDestinationable<PresentationConfiguration> where PresentationConfiguration : DestinationPresentationConfiguring
-
A typealias describing a UIKit-based
GroupedDestinationable
which also conforms toControllerDestinationable
.Declaration
Swift
public typealias GroupedControllerDestinationable<PresentationConfiguration> = GroupedDestinationable<PresentationConfiguration> & ControllerDestinationable<PresentationConfiguration> where PresentationConfiguration : DestinationPresentationConfiguring
-
A closure to be run when a Destination is presented in a tab.
Declaration
Swift
public typealias TabBarViewDestinationPresentationClosure<PresentationConfiguration> = (_ destination: any ViewDestinationable<PresentationConfiguration>, _ tabViewID: UUID) -> Void where PresentationConfiguration : DestinationPresentationConfiguring
-
A closure to be run when the
selectedTab
property changed.Declaration
Swift
public typealias TabBarViewSelectedTabUpdatedClosure<TabType> = (_ selectedTab: TabModel<TabType>) -> Void where TabType : TabTypeable
-
A closure to be run when the
selectedTab
property of aTabBarControllerDestinationable
object has changed.Declaration
Swift
public typealias TabBarControllerSelectedTabUpdatedClosure<TabType> = (_ selectedTab: TabModel<TabType>) -> Void where TabType : TabTypeable
-
A closure run when a sheet is dismissed.
Declaration
Swift
public typealias SheetDismissalClosure = () -> Void
-
A closure used for configuring a
UISheetPresentationController
before the sheet is presented.Declaration
Swift
public typealias SheetPresentationControllerConfigurationClosure = (_ presentationController: UISheetPresentationController) -> Void