Class

BackNavigationBehavior

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

Source set: Android
enum class BackNavigationBehavior {
    /** Pop the latest destination from the backstack. */
    PopLatest,

    /**
     * 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.
     */
    PopUntilScaffoldValueChange,

    /**
     * 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.
     */
    PopUntilCurrentDestinationChange,

    /**
     * Pop destinations from the backstack until there is a content change.
     *
     * A "content change" is defined as either a change in the content of the current
     * [ThreePaneScaffoldDestinationItem], or a change in the scaffold value (similar to
     * [PopUntilScaffoldValueChange]).
     */
    PopUntilContentChange,
}

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

Members

PopLatest

Source set: Android
PopLatest

Pop the latest destination from the backstack.

PopUntilScaffoldValueChange

Source set: Android
PopUntilScaffoldValueChange

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.

PopUntilCurrentDestinationChange

Source set: Android
PopUntilCurrentDestinationChange

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.

PopUntilContentChange

Source set: Android
PopUntilContentChange

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

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

Jetpack Compose beyond MaterialFree components, screens and templates for apps that don’t look like Google’s. Copy them into your app, or let your coding agent add them.Browse for free

Content updated: