View on GitHub
Flowable
@MainActor
public protocol Flowable : AnyObject, ObservableThis protocol represents Flow objects which coordinate routing, navigation, and the management of Destination objects as a user moves through an app’s interface.
Flows manage the creation, appearance, and removal of Destinations as a user navigates through the app. They are the single source of truth for what Destinations currently exist in the ecosystem. Typically you don’t interact with them directly after they’ve been configured. In most cases you can use one of the provided ViewFlow or ControllerFlow classes for SwiftUI and UIKit apps respectively.
-
An enum which defines all routable Destinations in the app.
Declaration
Swift
associatedtype DestinationType : RoutableDestinations -
An enum which defines types of tabs in a tab bar.
Declaration
Swift
associatedtype TabType : TabTypeable -
An enum which defines available Destination presentation types. Typically this is
DestinationPresentationType.Declaration
Swift
associatedtype PresentationType : DestinationPresentationTypeable -
An enum which defines the types of content that are able to be sent through Destinations.
Declaration
Swift
associatedtype ContentType : ContentTypeable -
A type of object that coordinates the presentation of a Destination within a UI framework.
Declaration
Swift
associatedtype InterfaceCoordinator : DestinationInterfaceCoordinating -
The currently presented Destination object.
Declaration
Swift
@MainActor var currentDestination: (any Destinationable<DestinationType, ContentType, TabType>)? { get set } -
An array of the active Destination objects. These are Destinations which have been presented and currently exist in the app’s user interface, even if they are not currently visible on screen.
Declaration
Swift
@MainActor var activeDestinations: [any Destinationable<DestinationType, ContentType, TabType>] { get set } -
The
DestinationInterfaceCoordinatingobject which coordinates the presentation of new Destinations within the app’s user interface.Declaration
Swift
@MainActor var uiCoordinator: InterfaceCoordinator? { get set } -
The root Destination of the user interface this Flow manages.
Declaration
Swift
@MainActor var rootDestination: (any Destinationable<DestinationType, ContentType, TabType>)? { get set } -
A queue of Destination presentations to be presented in serial order, used with the
presentDestinationPathmethod.Declaration
Swift
@MainActor var destinationQueue: [DestinationPresentation<DestinationType, ContentType, TabType>] { get set } -
Starts the presentation of the Destination defined by the
startingDestinationconfiguration object.Declaration
Swift
@MainActor func start() -
destination(for:Default implementation) Returns the Destination object associated with an identifier.
Default Implementation
Declaration
Swift
@MainActor func destination(for destinationID: UUID) -> (any Destinationable<DestinationType, ContentType, TabType>)?Parameters
destinationIDA
UUIDidentifier of the Destination to return.Return Value
A
Destinationableobject, if one is found. -
updateDestination(destination:Default implementation) Updates a stored Destination with a new one matching its identifier.
Default Implementation
Declaration
Swift
@MainActor func updateDestination(destination: any Destinationable<DestinationType, ContentType, TabType>)Parameters
destinationA
Destinationableobject to replace the current one with. -
updateCurrentDestination(destination:Default implementation) Updates the currently presented Destination stored in
currentDestination.Default Implementation
Declaration
Swift
@MainActor func updateCurrentDestination(destination: any Destinationable<DestinationType, ContentType, TabType>)Parameters
destinationThe new current Destination.
-
updateActiveDestinations(with:Default implementation) Adds a new Destination to the
activeDestinationsarray.Default Implementation
Declaration
Swift
@MainActor func updateActiveDestinations(with destination: any Destinationable<DestinationType, ContentType, TabType>)Parameters
destinationThe
Destinationableobject to add. -
removeDestination(destinationID:Default implementation) Removes a Destination and any of its children.
Note
If this is the current Destination,
currentDestinationwill become nil.Default Implementation
Declaration
Swift
@MainActor func removeDestination(destinationID: UUID)Parameters
destinationIDThe identifier of the Destination to remove.
-
removeDestinations(destinationIDs:Default implementation) Removes multiple Destinations and any of their children.
Note
If one of these Destinations is the current one,
currentDestinationwill become nil.Default Implementation
Declaration
Swift
@MainActor func removeDestinations(destinationIDs: [UUID])Parameters
destinationIDsAn array of identifiers for the Destinations to remove.
-
activateCompletionClosure(for:Default implementationpresentationID: didComplete: isSystemNavigationAction: ) Activates a presentation completion closure corresponding to the specified Destination and presentation identifiers.
Default Implementation
Declaration
Swift
@MainActor func activateCompletionClosure(for destinationID: UUID, presentationID: UUID, didComplete: Bool, isSystemNavigationAction: Bool)Parameters
destinationIDThe identifier of the Destination the closure is associated with.
presentationIDThe identifier of the presentation configuration object the closure is associated with.
didCompleteA Boolean indicating whether the presentation completed successfully.
isSystemNavigationActionA Boolean indicating whether this is a system navigation action.
-
Returns the default completion closure that is activated when a Destination presentation has completed.
Declaration
Swift
@MainActor func defaultCompletionClosure(configuration: DestinationPresentation<DestinationType, ContentType, TabType>, destination: (any Destinationable<DestinationType, ContentType, TabType>)?) -> PresentationCompletionClosure?Parameters
configurationThe presentation configuration object.
destinationThe
Destinationableobject which was presented.Return Value
A completion closure.
-
Returns the default completion closure that is activated when a currently presented UI sheet was dismissed.
Declaration
Swift
@MainActor func defaultSheetDismissalCompletionClosure(configuration: DestinationPresentation<DestinationType, ContentType, TabType>) -> PresentationCompletionClosure?Parameters
configurationThe presentation configuration object associated with this action.
Return Value
A completion closure.
-
Returns the default completion closure that is activated when a UI navigation path has moved back to the previous Destination.
Declaration
Swift
@MainActor func defaultNavigationBackCompletionClosure(configuration: DestinationPresentation<DestinationType, ContentType, TabType>) -> PresentationCompletionClosure?Parameters
configurationThe presentation configuration object associated with this action.
Return Value
A completion closure.
-
presentDestinationPath(path:Default implementationcontentToPass: ) Presents a nested path of Destination objects, displaying them serially within the user interface.
Discussion
This method can be used to provide deep links into an app’s interface.
Default Implementation
Declaration
Swift
@MainActor func presentDestinationPath(path: [DestinationPresentation<DestinationType, ContentType, TabType>], contentToPass: ContentType?)Parameters
pathAn array of presentation configuration objects. The order of the configuration objects in the array determines the order in which their associated Destinations will be presented.
-
Presents the next Destination in the
destinationQueuearray, if one exists.Declaration
Swift
@discardableResult @MainActor func presentNextDestinationInQueue(contentToPass: ContentType?) -> (any Destinationable<DestinationType, ContentType, TabType>)?Return Value
The newly presented Destination, if any configuration objects were left in the queue.
-
Returns a closure to run when a presentation has completed.
Declaration
Swift
@MainActor func presentationCompletionClosure(for configuration: DestinationPresentation<DestinationType, ContentType, TabType>, destination: (any Destinationable<DestinationType, ContentType, TabType>)?) -> PresentationCompletionClosure?Parameters
configurationA presentation configuration model to use with the closure.
destinationThe Destination being presented. This is not used with system navigation events.
Return Value
The presentation closure.
-
logDestinationPresented(destination:Default implementationconfiguration: ) Logs the type of Destination presentation.
Default Implementation
Declaration
Swift
@MainActor func logDestinationPresented(destination: (any Destinationable<DestinationType, ContentType, TabType>)?, configuration: DestinationPresentation<DestinationType, ContentType, TabType>)Parameters
destinationThe Destination that was presented.
configurationThe presentation configuration model associated with this presentation.