rememberCircuitNavigator

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


fun rememberCircuitNavigator(navStack: NavStack<out NavStack.Record>, enableBackHandler: Boolean = true): Navigator(source)

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

Parameters

navStack

The backing NavStack to navigate.

enableBackHandler

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

See also

Creates and remembers a new Navigator for navigating within CircuitContents. A new Navigator will be created if the backStack instance changes.

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


fun rememberCircuitNavigator(navStack: NavStack<out NavStack.Record>, onRootPop: (result: PopResult?) -> Unit): Navigator(source)

Creates and remembers a new Navigator for navigating within CircuitContents. A new Navigator will be created if the navStack instance changes.

Parameters

navStack

The backing NavStack to navigate.

onRootPop

Invoked when the backstack NavStack.isAtRoot and a Navigator.pop is called.

See also


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 NavigationBackHandler.

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


fun rememberCircuitNavigator(navStack: NavStack<out NavStack.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

navStack

The backing NavStack to navigate.

onRootPop

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

enableBackHandler

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

See also