AppBarConfigurationKt

Added in 1.0.0

---

Kotlin |Java

public final class AppBarConfigurationKt

---

Summary

Public methods
static final @NonNull AppBarConfiguration	AppBarConfiguration(     @NonNull NavGraph navGraph,     Openable drawerLayout,     @NonNull Function0<@NonNull Boolean> fallbackOnNavigateUpListener ) Configuration options for NavigationUI methods that interact with implementations of the app bar pattern such as androidx.appcompat.widget.Toolbar, com.google.android.material.appbar.CollapsingToolbarLayout, and androidx.appcompat.app.ActionBar.
static final @NonNull AppBarConfiguration	AppBarConfiguration(     @NonNull Set<@NonNull Integer> topLevelDestinationIds,     Openable drawerLayout,     @NonNull Function0<@NonNull Boolean> fallbackOnNavigateUpListener ) Configuration options for NavigationUI methods that interact with implementations of the app bar pattern such as androidx.appcompat.widget.Toolbar, com.google.android.material.appbar.CollapsingToolbarLayout, and androidx.appcompat.app.ActionBar.
static final @NonNull AppBarConfiguration	AppBarConfiguration(     @NonNull Menu topLevelMenu,     Openable drawerLayout,     @NonNull Function0<@NonNull Boolean> fallbackOnNavigateUpListener ) Configuration options for NavigationUI methods that interact with implementations of the app bar pattern such as androidx.appcompat.widget.Toolbar, com.google.android.material.appbar.CollapsingToolbarLayout, and androidx.appcompat.app.ActionBar.

Public methods

AppBarConfiguration

Artifact: androidx.navigation:navigation-ui

View Source

Added in 2.3.0

public static final @NonNull AppBarConfiguration AppBarConfiguration(
    @NonNull NavGraph navGraph,
    Openable drawerLayout,
    @NonNull Function0<@NonNull Boolean> fallbackOnNavigateUpListener
)

Configuration options for NavigationUI methods that interact with implementations of the app bar pattern such as androidx.appcompat.widget.Toolbar, com.google.android.material.appbar.CollapsingToolbarLayout, and androidx.appcompat.app.ActionBar.

Parameters
@NonNull NavGraph navGraph	The NavGraph whose start destination should be considered the only top level destination. The Up button will not be displayed when on the start destination of the graph.
Openable drawerLayout	The Openable layout that should be toggled from the Navigation button. The the Navigation button will show a drawer symbol when it is not being shown as an Up button.
@NonNull Function0<@NonNull Boolean> fallbackOnNavigateUpListener	Lambda that will be invoked if androidx.navigation.NavController.navigateUp returns false

AppBarConfiguration

Artifact: androidx.navigation:navigation-ui

View Source

Added in 2.3.0

public static final @NonNull AppBarConfiguration AppBarConfiguration(
    @NonNull Set<@NonNull Integer> topLevelDestinationIds,
    Openable drawerLayout,
    @NonNull Function0<@NonNull Boolean> fallbackOnNavigateUpListener
)

Configuration options for NavigationUI methods that interact with implementations of the app bar pattern such as androidx.appcompat.widget.Toolbar, com.google.android.material.appbar.CollapsingToolbarLayout, and androidx.appcompat.app.ActionBar.

Parameters
@NonNull Set<@NonNull Integer> topLevelDestinationIds	The set of destinations by id considered at the top level of your information hierarchy. The Up button will not be displayed when on these destinations.
Openable drawerLayout	The Openable layout that should be toggled from the Navigation button. The the Navigation button will show a drawer symbol when it is not being shown as an Up button.
@NonNull Function0<@NonNull Boolean> fallbackOnNavigateUpListener	Lambda that will be invoked if androidx.navigation.NavController.navigateUp returns false

AppBarConfiguration

Artifact: androidx.navigation:navigation-ui

View Source

Added in 2.3.0

public static final @NonNull AppBarConfiguration AppBarConfiguration(
    @NonNull Menu topLevelMenu,
    Openable drawerLayout,
    @NonNull Function0<@NonNull Boolean> fallbackOnNavigateUpListener
)

Configuration options for NavigationUI methods that interact with implementations of the app bar pattern such as androidx.appcompat.widget.Toolbar, com.google.android.material.appbar.CollapsingToolbarLayout, and androidx.appcompat.app.ActionBar.

Parameters
@NonNull Menu topLevelMenu	A Menu containing MenuItems corresponding with the destinations considered at the top level of your information hierarchy. The Up button will not be displayed when on these destinations.
Openable drawerLayout	The Openable layout that should be toggled from the Navigation button. The the Navigation button will show a drawer symbol when it is not being shown as an Up button.
@NonNull Function0<@NonNull Boolean> fallbackOnNavigateUpListener	Lambda that will be invoked if androidx.navigation.NavController.navigateUp returns false