circuit-runtime/com.slack.circuit.runtime/Navigator/NoOp

NoOp

object NoOp : Navigator(source)

A no-op implementation of Navigator that performs no actual navigation.

Functions

open override fun backward(): Boolean

Move backward in navigation history toward the root.

open override fun forward(): Boolean

Move forward in navigation history toward the top.

open override fun goTo(screen: Screen): Boolean

Navigate to the screen.

open override fun peek(): Screen?

Returns current top most screen of backstack, or null if the navStack is empty.

open override fun peekBackStack(): List<Screen>

Returns the current back stack.

open override fun peekNavStack(): NavStackList<Screen>?

Returns a snapshot of the current navigation stack, or null if empty.

open override fun pop(result: PopResult?): Screen?

Remove and return the current screen from the navigation stack.

fun Navigator.popRoot(result: PopResult? = null)

Pop the Navigator as if this was the root Navigator.pop call.

fun Navigator.popUntil(predicate: (Screen) -> Boolean)

Calls Navigator.pop until the given predicate is matched or it pops the root.

open override fun resetRoot(newRoot: Screen, options: Navigator.StateOptions): List<Screen>

Clear the existing backstack of screens and navigate to newRoot.

fun Navigator.resetRoot(newRoot: Screen, saveState: Boolean = false, restoreState: Boolean = false, clearState: Boolean = false): List<Screen>

Parameter based alternate for Navigator.resetRoot.

inline fun Navigator.resetRoot(newRoot: Screen, saveState: (currentRoot: Screen?) -> Boolean = { false }, restoreState: (currentRoot: Screen?) -> Boolean = { false }, clearState: (currentRoot: Screen?) -> Boolean = { false }): List<Screen>

Clear the existing backstack of screens and navigate to newRoot.