View on GitHub
Hide Structure Reference
Hide
public struct Hide : NavigationSideEffectextension Hide: CustomDebugStringConvertibleNavigation action used to ask the Navigator to hide a specific screen
identified by the identifierToHide.
The ViewController that is managing that screen must implement RoutableWithConfiguration
or Routable in order to be identified with a matching Routable.routeIdentifier.
-
The identifier of the
Routableto be hiddenDeclaration
Swift
public let identifierToHide: RouteElementIdentifier -
Specify if the
Hideshould be animatedDeclaration
Swift
public let animated: Bool -
The context of the
HideDeclaration
Swift
public let context: Any? -
Specify if the Hide should generate one single navigation request. For instance, if we have a Route like
A/B/C/Dand we ask to hideB, withatomic = false, three different Hide commands will be generated: the request to hide D, then the request to hide C and finally the request to hide B. If we useatomic = true, only the request to hide B will be generated.Declaration
Swift
public let atomic: Bool -
Initializes and returns a Hide action.
Declaration
Swift
public init(_ identifierToHide: RouteElementIdentifier, animated: Bool = false, context: Any? = nil, atomic: Bool = false) -
Initializes and returns a Hide action.
Declaration
Swift
public init<K>(_ identifierToHide: K, animated: Bool = false, context: Any? = nil) where K: RawRepresentable, K.RawValue == RouteElementIdentifier -
Initializes and returns a Hide action.
Declaration
Swift
public init<K>(_ identifierToHide: K, animated: Bool = false, context: Any? = nil, atomic: Bool = false) where K: RawRepresentable, K.RawValue == RouteElementIdentifier -
Initializes and return a Hide action.
Declaration
Swift
public init(animated: Bool = false, context: Any? = nil, atomic: Bool = false) -
The side effect of the action, look into Katana to know what a
SideEffectis.Declaration
Swift
public func anySideEffect(_ context: AnySideEffectContext) throws -> Any -
Declaration
Swift
public var debugDescription: String { get }