GroupedDestinationable

@MainActor
public protocol GroupedDestinationable<DestinationType, ContentType, TabType> : AnyObject

This abstract protocol represents a type of Destination which manages child Destinations, such as a NavigationStack in SwiftUI.

Note

Protocols or classes that should take on group behavior should use GroupedViewDestinationable for SwiftUI projects and GroupedControllerDestinationable for UIKit projects.

  • 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 the types of content that are able to be sent through Destinations.

    Declaration

    Swift

    associatedtype ContentType : ContentTypeable
  • id

    The unique identifier for this Destination.

    Declaration

    Swift

    @MainActor
var id: UUID { get }

  • State object for handling functionality for the Destinations ecosystem.

    Declaration

    Swift

    @MainActor
var groupInternalState: GroupDestinationInternalState<DestinationType, ContentType, TabType> { get set }
  • assignChildRemovedClosure(closure:) Default implementation

    Assigns a closure to be run when a child Destination is removed from this Group. This closure should be used by an associated Destination to respond to child removals that happened internally.

    Default Implementation

    Declaration

    Swift

    @MainActor
func assignChildRemovedClosure(closure: @escaping GroupChildRemovedClosure)

    Parameters

    closure

    A closure.

  • Assigns a closure to be run when the current child Destination has changed. This closure should be used by an associated Destination to respond to current Destination changes that happened internally.

    Default Implementation

    Declaration

    Swift

    @MainActor
func assignCurrentDestinationChangedClosure(closure: @escaping GroupCurrentDestinationChangedClosure)

    Parameters

    closure

    A closure.

  • Adds a child Destination to this group.

    Default Implementation

    Declaration

    Swift

    @MainActor
func addChild(childDestination: any Destinationable<DestinationType, ContentType, TabType>, shouldSetDestinationAsCurrent: Bool?, shouldAnimate: Bool?)

    Parameters

    childDestination

    A Destinationable object to add.
    shouldSetDestinationAsCurrent

    A Boolean which determines whether this Destination should become the current one.
    shouldAnimate

    A Boolean which determines whether this Destination should be animated when presented in the Group.

  • Removes a child Destination.

    Default Implementation

    Declaration

    Swift

    @MainActor
func removeChild(identifier: UUID, removeDestinationFromFlowClosure: RemoveDestinationFromFlowClosure?)

    Parameters

    destinationIdentifier

    The identifier of the Destination to remove.

    • removeDestinationClosure: A closure that notifies an external object when this Destination has removed one of its children. Typically this will be passed in when being called from a DestinationPresentation object, and handles the removal of the child Destination from the active Flow object. The identifier of the child that was removed should be passed in to the closure.
  • removeAllChildren() Default implementation

    Removes all child Destinations from this group.

    Default Implementation

    Declaration

    Swift

    @MainActor
func removeAllChildren()

  • Returns the child Destination for the specified identifier.

    Default Implementation

    Declaration

    Swift

    @MainActor
func childForIdentifier(destinationIdentifier: UUID) -> (any Destinationable<DestinationType, ContentType, TabType>)?

    Parameters

    destinationIdentifier

    The identifier of the child Destination.

    Return Value

    The child Destination, if one was found.

  • replaceCurrentDestination(with:) Default implementation

    Replaces the child Destination that currently has focus.

    Default Implementation

    Declaration

    Swift

    @MainActor
func replaceCurrentDestination(with newDestination: any Destinationable<DestinationType, ContentType, TabType>)

    Parameters

    newDestination

    The new Destinationable object that should replace the current Destination referenced by currentChildDestination.

  • Replaces the current child Destination.

    Default Implementation

    Declaration

    Swift

    @MainActor
func replaceChild(currentID: UUID, with newDestination: any Destinationable<DestinationType, ContentType, TabType>, removeDestinationFromFlowClosure: RemoveDestinationFromFlowClosure?)

    Parameters

    currentID

    A UUID identifier matching the child Destination which should be replaced.
    newDestination

    A Destinationable object to replace an existing child Destination.
    removeDestinationClosure

    A closure that notifies an external object when this Destination has removed one of its children. Typically this will be passed in when being called from a DestinationPresentation object, and handles the removal of the child Destination from the active Flow object. The identifier of the child that was removed should be passed in to the closure.

  • Updates the currently active Destination with an identifier of another child.

    Default Implementation

    Declaration

    Swift

    @MainActor
func updateCurrentDestination(destinationID: UUID)

    Parameters

    destinationID

    The Destination identifier to use. This Destination must be a current child.
  • updateChildren() Default implementation

    Provides a method for requesting the children of a Destination group be updated in some way.

    Default Implementation

    Declaration

    Swift

    @MainActor
func updateChildren()
  • childDestinations() Default implementation

    Returns the child Destinations of this group.

    Default Implementation

    Declaration

    Swift

    @MainActor
func childDestinations() -> [any Destinationable<DestinationType, ContentType, TabType>]

    Return Value

    The Destinations belonging to this gorup.

  • currentChildDestination() Default implementation

    Returns the currently active child Destination.

    Default Implementation

    Declaration

    Swift

    @MainActor
func currentChildDestination() -> (any Destinationable<DestinationType, ContentType, TabType>)?

    Return Value

    The current child Destination.

  • Determines whether this Destination supports the shouldSetDestinationAsCurrent parameter of the addChild method. If this Destination should ignore requests to not make added children the current Destination, this property should be set to false.

    Default Implementation

    Declaration

    Swift

    @MainActor
func supportsIgnoringCurrentDestinationStatus() -> Bool

    Return Value

    Returns whether the current Destination status should be ignored.