AppBarConfiguration.Builder

class AppBarConfiguration.Builder


The Builder class for constructing new AppBarConfiguration instances.

Summary

Public constructors

Builder(navGraph: NavGraph)

Create a new Builder whose only top level destination is the start destination of the given NavGraph.

Builder(vararg topLevelDestinationIds: Int)

Create a new Builder with a specific set of top level destinations.

Builder(topLevelDestinationIds: Set<Int>)

Create a new Builder with a specific set of top level destinations.

Builder(topLevelMenu: Menu)

Create a new Builder using a Menu containing all top level destinations.

Public functions

AppBarConfiguration

Construct the AppBarConfiguration instance.

AppBarConfiguration.Builder
setDrawerLayout(drawerLayout: DrawerLayout?)

This function is deprecated. Use {@link #setOpenableLayout(Openable)}.

AppBarConfiguration.Builder

Adds a OnNavigateUpListener that will be called as a fallback if the default behavior of androidx.navigation.NavController.navigateUp returns false.

AppBarConfiguration.Builder
setOpenableLayout(openableLayout: Openable?)

Display the Navigation button as a drawer symbol when it is not being shown as an Up button.

Public constructors

Builder

Added in 1.0.0
Builder(navGraph: NavGraph)

Create a new Builder whose only top level destination is the start destination of the given NavGraph. The Up button will not be displayed when on the start destination of the graph.

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

Builder

Added in 1.0.0
Builder(vararg topLevelDestinationIds: Int)

Create a new Builder with a specific set of top level destinations. The Up button will not be displayed when on these destinations.

Parameters
vararg topLevelDestinationIds: Int

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.

Builder

Added in 1.0.0
Builder(topLevelDestinationIds: Set<Int>)

Create a new Builder with a specific set of top level destinations. The Up button will not be displayed when on these destinations.

Parameters
topLevelDestinationIds: Set<Int>

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.

Builder

Added in 1.0.0
Builder(topLevelMenu: Menu)

Create a new Builder using a Menu containing all top level destinations. It is expected that the menu item id of each item corresponds with a destination in your navigation graph. The Up button will not be displayed when on these destinations.

Parameters
topLevelMenu: Menu

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.

Public functions

build

Added in 1.0.0
fun build(): AppBarConfiguration

Construct the AppBarConfiguration instance.

setDrawerLayout

Added in 2.0.0
Deprecated in 2.3.0
fun setDrawerLayout(drawerLayout: DrawerLayout?): AppBarConfiguration.Builder

Display the Navigation button as a drawer symbol when it is not being shown as an Up button.

Parameters
drawerLayout: DrawerLayout?

The DrawerLayout that should be toggled from the Navigation button

setFallbackOnNavigateUpListener

Added in 1.0.0
fun setFallbackOnNavigateUpListener(
    fallbackOnNavigateUpListener: AppBarConfiguration.OnNavigateUpListener?
): AppBarConfiguration.Builder

Adds a OnNavigateUpListener that will be called as a fallback if the default behavior of androidx.navigation.NavController.navigateUp returns false.

Parameters
fallbackOnNavigateUpListener: AppBarConfiguration.OnNavigateUpListener?

Listener that will be invoked if androidx.navigation.NavController.navigateUp returns false.

setOpenableLayout

Added in 2.3.0
fun setOpenableLayout(openableLayout: Openable?): AppBarConfiguration.Builder

Display the Navigation button as a drawer symbol when it is not being shown as an Up button.

Parameters
openableLayout: Openable?

The Openable layout that should be toggled from the Navigation button