circuit-foundation/com.slack.circuit.foundation/rememberCircuitNavigator

rememberCircuitNavigator

@Composable
fun rememberCircuitNavigator(backStack: BackStack<out BackStack.Record>, enableBackHandler: Boolean = true): Navigator(source)

Returns a new Navigator for navigating within CircuitContents. Delegates onRootPop to the LocalOnBackPressedDispatcherOwner.

Parameters

backStack

The backing BackStack to navigate.

enableBackHandler

Indicates whether or not Navigator.pop should be called by the system back handler. Defaults to true.

See also

@Composable
fun rememberCircuitNavigator(backStack: BackStack<out BackStack.Record>, onRootPop: (result: PopResult?) -> Unit): Navigator(source)

Creates and remembers a new Navigator for navigating within CircuitContents.

Parameters

backStack

The backing BackStack to navigate.

onRootPop

Invoked when the backstack is at root (size 1) and the user presses the back button.

See also

@Composable
fun rememberCircuitNavigator(backStack: BackStack<out BackStack.Record>, onRootPop: (result: PopResult?) -> Unit, enableBackHandler: Boolean = true): Navigator(source)

Returns a new Navigator for navigating within CircuitContents while also handling back events with a BackHandler.

Parameters

backStack

The backing BackStack to navigate.

onRootPop

Invoked when the backstack is at root (size 1) and the user presses the back button.

enableBackHandler

Indicates whether or not Navigator.pop should be called by the system back handler. Defaults to true.

See also