NavigationUI

fun navigateUp(
    navController: NavController,
    configuration: AppBarConfiguration
): Boolean

Handles the Up button by delegating its behavior to the given NavController. This is an alternative to using NavController.navigateUp directly when the given AppBarConfiguration needs to be considered when determining what should happen when the Up button is pressed.

In cases where no Up action is available, the AppBarConfiguration.fallbackOnNavigateUpListener will be called to provide additional control.

fun navigateUp(navController: NavController, openableLayout: Openable?): Boolean

Handles the Up button by delegating its behavior to the given NavController. This should generally be called from AppCompatActivity.onSupportNavigateUp.

If you do not have a Openable layout, you should call NavController.navigateUp directly.

fun onNavDestinationSelected(item: MenuItem, navController: NavController): Boolean

Attempt to navigate to the NavDestination associated with the given MenuItem. This MenuItem should have been added via one of the helper methods in this class.

Importantly, it assumes the menu item id matches a valid action id or destination id to be navigated to.

By default, the back stack will be popped back to the navigation graph's start destination. Menu items that have android:menuCategory="secondary" will not pop the back stack.

@NavigationUiSaveStateControl
fun onNavDestinationSelected(
    item: MenuItem,
    navController: NavController,
    saveState: Boolean
): Boolean

Attempt to navigate to the NavDestination associated with the given MenuItem. This MenuItem should have been added via one of the helper methods in this class.

Importantly, it assumes the menu item id matches a valid action id or destination id to be navigated to.

By default, the back stack will be popped back to the navigation graph's start destination. Menu items that have android:menuCategory="secondary" will not pop the back stack.

fun setupActionBarWithNavController(
    activity: AppCompatActivity,
    navController: NavController,
    configuration: AppBarConfiguration = AppBarConfiguration.Builder(navController.graph).build()
): Unit

Sets up the ActionBar returned by AppCompatActivity.getSupportActionBar for use with a NavController.

By calling this method, the title in the action bar will automatically be updated when the destination changes (assuming there is a valid label).

The AppBarConfiguration you provide controls how the Navigation button is displayed. Call navigateUp to handle the Up button.

Destinations that implement androidx.navigation.FloatingWindow will be ignored.

fun setupActionBarWithNavController(
    activity: AppCompatActivity,
    navController: NavController,
    openableLayout: Openable?
): Unit

Sets up the ActionBar returned by AppCompatActivity.getSupportActionBar for use with a NavController.

By calling this method, the title in the action bar will automatically be updated when the destination changes (assuming there is a valid label).

The start destination of your navigation graph is considered the only top level destination. On the start destination of your navigation graph, the ActionBar will show the drawer icon if the given Openable layout is non null. On all other destinations, the ActionBar will show the Up button. Call navigateUp to handle the Up button.

Destinations that implement androidx.navigation.FloatingWindow will be ignored.

fun setupWithNavController(
    navigationBarView: NavigationBarView,
    navController: NavController
): Unit

Sets up a NavigationBarView for use with a NavController. This will call onNavDestinationSelected when a menu item is selected. The selected item in the NavigationBarView will automatically be updated when the destination changes.

Destinations that implement androidx.navigation.FloatingWindow will be ignored.

fun setupWithNavController(
    navigationView: NavigationView,
    navController: NavController
): Unit

Sets up a NavigationView for use with a NavController. This will call onNavDestinationSelected when a menu item is selected. The selected item in the NavigationView will automatically be updated when the destination changes.

If the NavigationView is directly contained with an Openable layout, it will be closed when a menu item is selected.

Similarly, if the NavigationView has a BottomSheetBehavior associated with it (as is the case when using a com.google.android.material.bottomsheet.BottomSheetDialog), the bottom sheet will be hidden when a menu item is selected.

Destinations that implement androidx.navigation.FloatingWindow will be ignored.

@NavigationUiSaveStateControl
fun setupWithNavController(
    navigationBarView: NavigationBarView,
    navController: NavController,
    saveState: Boolean
): Unit

Sets up a NavigationBarView for use with a NavController. This will call onNavDestinationSelected when a menu item is selected. The selected item in the NavigationBarView will automatically be updated when the destination changes.

Destinations that implement androidx.navigation.FloatingWindow will be ignored.

@NavigationUiSaveStateControl
fun setupWithNavController(
    navigationView: NavigationView,
    navController: NavController,
    saveState: Boolean
): Unit

Sets up a NavigationView for use with a NavController. This will call onNavDestinationSelected when a menu item is selected. The selected item in the NavigationView will automatically be updated when the destination changes.

If the NavigationView is directly contained with an Openable layout, it will be closed when a menu item is selected.

Similarly, if the NavigationView has a BottomSheetBehavior associated with it (as is the case when using a com.google.android.material.bottomsheet.BottomSheetDialog), the bottom sheet will be hidden when a menu item is selected.

Destinations that implement androidx.navigation.FloatingWindow will be ignored.

fun setupWithNavController(
    toolbar: Toolbar,
    navController: NavController,
    configuration: AppBarConfiguration = AppBarConfiguration.Builder(navController.graph).build()
): Unit

Sets up a Toolbar for use with a NavController.

By calling this method, the title in the Toolbar will automatically be updated when the destination changes (assuming there is a valid label).

The AppBarConfiguration you provide controls how the Navigation button is displayed and what action is triggered when the Navigation button is tapped. This method will call navigateUp when the Navigation button is clicked.

Destinations that implement androidx.navigation.FloatingWindow will be ignored.

fun setupWithNavController(
    toolbar: Toolbar,
    navController: NavController,
    openableLayout: Openable?
): Unit

Sets up a Toolbar for use with a NavController.

By calling this method, the title in the Toolbar will automatically be updated when the destination changes (assuming there is a valid label).

The start destination of your navigation graph is considered the only top level destination. On the start destination of your navigation graph, the Toolbar will show the drawer icon if the given Openable layout is non null. On all other destinations, the Toolbar will show the Up button. This method will call navigateUp when the Navigation button is clicked.

Destinations that implement androidx.navigation.FloatingWindow will be ignored.

fun setupWithNavController(
    collapsingToolbarLayout: CollapsingToolbarLayout,
    toolbar: Toolbar,
    navController: NavController,
    configuration: AppBarConfiguration = AppBarConfiguration.Builder(navController.graph).build()
): Unit

Sets up a CollapsingToolbarLayout and Toolbar for use with a NavController.

By calling this method, the title in the CollapsingToolbarLayout will automatically be updated when the destination changes (assuming there is a valid label).

The AppBarConfiguration you provide controls how the Navigation button is displayed and what action is triggered when the Navigation button is tapped. This method will call navigateUp when the Navigation button is clicked.

Destinations that implement androidx.navigation.FloatingWindow will be ignored.

fun setupWithNavController(
    collapsingToolbarLayout: CollapsingToolbarLayout,
    toolbar: Toolbar,
    navController: NavController,
    openableLayout: Openable?
): Unit

Sets up a CollapsingToolbarLayout and Toolbar for use with a NavController.

By calling this method, the title in the CollapsingToolbarLayout will automatically be updated when the destination changes (assuming there is a valid label).

The start destination of your navigation graph is considered the only top level destination. On the start destination of your navigation graph, the Toolbar will show the drawer icon if the given Openable layout is non null. On all other destinations, the Toolbar will show the Up button. This method will call navigateUp when the Navigation button is clicked.

Destinations that implement androidx.navigation.FloatingWindow will be ignored.