A class to control how back navigation should behave in a ThreePaneScaffoldNavigator.

Summary

Public companion properties

BackNavigationBehavior

Pop the latest destination from the backstack.

Cmn
BackNavigationBehavior

Pop destinations from the backstack until there is a content change.

Cmn
BackNavigationBehavior

Pop destinations from the backstack until there is a change in the current destination pane.

Cmn
BackNavigationBehavior

Pop destinations from the backstack until there is a change in the scaffold value.

Cmn

Public functions

open String
Cmn

Public companion properties

PopLatest

val PopLatestBackNavigationBehavior

Pop the latest destination from the backstack.

PopUntilContentChange

val PopUntilContentChangeBackNavigationBehavior

Pop destinations from the backstack until there is a content change.

A "content change" is defined as either a change in the contentKey of the current ThreePaneScaffoldDestinationItem, or a change in the scaffold value (similar to PopUntilScaffoldValueChange).

PopUntilCurrentDestinationChange

val PopUntilCurrentDestinationChangeBackNavigationBehavior

Pop destinations from the backstack until there is a change in the current destination pane.

In a single-pane layout, this should behave similarly to PopUntilScaffoldValueChange. In a multi-pane layout, it is possible for both the current destination and previous destination to be showing at the same time, so this may not result in a visual change in the scaffold.

PopUntilScaffoldValueChange

val PopUntilScaffoldValueChangeBackNavigationBehavior

Pop destinations from the backstack until there is a change in the scaffold value.

For example, in a single-pane layout, this will skip entries until the current destination is a different ThreePaneScaffoldRole. In a multi-pane layout, this will skip entries until the PaneAdaptedValue of any pane changes.

Public functions

toString

open fun toString(): String