NavGraphBuilder

Kotlin |Java

open class NavGraphBuilder : NavDestinationBuilder<NavGraph>

kotlin.Any
↳	androidx.navigation.NavDestinationBuilder<androidx.navigation.NavGraph>
	↳	androidx.navigation.NavGraphBuilder

Known Direct Subclasses

DynamicNavGraphBuilder

DSL for constructing a new DynamicGraphNavigator.DynamicNavGraph

DSL for constructing a new NavGraph

Summary

Public constructors
`<init>(provider: NavigatorProvider, @IdRes id: Int, @IdRes startDestination: Int)` DSL for constructing a new NavGraph

Public methods
Unit	`addDestination(destination: NavDestination)` Add the destination to the NavGraphBuilder
open NavGraph	`build()` Build the NavDestination by calling Navigator.createDestination.
Unit	`destination(navDestination: NavDestinationBuilder<D>)` Build and add a new destination to the NavGraphBuilder
operator Unit	`NavDestination.unaryPlus()` Adds this destination to the NavGraphBuilder

Inherited functions

From class NavDestinationBuilder

`Unit`	`action(actionId: Int, actionBuilder: NavActionBuilder.() -> Unit)` Adds a new NavAction to the destination
`Unit`	`argument(name: String, argumentBuilder: NavArgumentBuilder.() -> Unit)` Add a NavArgument to this destination.
`Unit`	`deepLink(uriPattern: String)` Add a deep link to this destination. In addition to a direct Uri match, the following features are supported: Uris without a scheme are assumed as http and https. For example, `www.example.com` will match `http://www.example.com` and `https://www.example.com`. Placeholders in the form of `{placeholder_name}` matches 1 or more characters. The String value of the placeholder will be available in the arguments Bundle with a key of the same name. For example, `http://www.example.com/users/{id}` will match `http://www.example.com/users/4`. The `.*` wildcard can be used to match 0 or more characters.
`Unit`	`deepLink(navDeepLink: NavDeepLinkDslBuilder.() -> Unit)` Add a deep link to this destination. In addition to a direct Uri match, the following features are supported: Uris without a scheme are assumed as http and https. For example, `www.example.com` will match `http://www.example.com` and `https://www.example.com`. Placeholders in the form of `{placeholder_name}` matches 1 or more characters. The String value of the placeholder will be available in the arguments Bundle with a key of the same name. For example, `http://www.example.com/users/{id}` will match `http://www.example.com/users/4`. The `.*` wildcard can be used to match 0 or more characters.

Extension functions

From androidx.navigation

Unit	`NavGraphBuilder.activity(@IdRes id: Int, builder: ActivityNavigatorDestinationBuilder.() -> Unit)` Construct a new ActivityNavigator.Destination
Unit	`NavGraphBuilder.navigation(@IdRes id: Int, @IdRes startDestination: Int, builder: NavGraphBuilder.() -> Unit)` Construct a nested NavGraph

From androidx.navigation.fragment

Unit	`NavGraphBuilder.dialog(@IdRes id: Int)` Construct a new DialogFragmentNavigator.Destination
Unit	`NavGraphBuilder.dialog(@IdRes id: Int, builder: DialogFragmentNavigatorDestinationBuilder.() -> Unit)` Construct a new DialogFragmentNavigator.Destination
Unit	`NavGraphBuilder.fragment(@IdRes id: Int)` Construct a new FragmentNavigator.Destination
Unit	`NavGraphBuilder.fragment(@IdRes id: Int, builder: FragmentNavigatorDestinationBuilder.() -> Unit)` Construct a new FragmentNavigator.Destination

Properties
NavigatorProvider	`provider`

Inherited properties

From class NavDestinationBuilder

Int

id

CharSequence?

label

The descriptive label of the destination

Navigator<out D>

navigator

Public constructors

<init>

NavGraphBuilder(
    provider: NavigatorProvider, 
    @IdRes id: Int, 
    @IdRes startDestination: Int)

DSL for constructing a new NavGraph

Public methods

addDestination

fun addDestination(destination: NavDestination): Unit

Add the destination to the NavGraphBuilder

build

open fun build(): NavGraph

Build the NavDestination by calling Navigator.createDestination.

destination

fun <D : NavDestination> destination(navDestination: NavDestinationBuilder<D>): Unit

Build and add a new destination to the NavGraphBuilder

unaryPlus

operator fun NavDestination.unaryPlus(): Unit

Adds this destination to the NavGraphBuilder

Properties

provider

val provider: NavigatorProvider