NavGraphBuilderKt

Added in 1.0.0

---

Kotlin |Java

public final class NavGraphBuilderKt

---

Summary

Public methods
static final void	navigation(     @NonNull NavGraphBuilder receiver,     @IdRes int id,     @IdRes int startDestination,     @ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder ) This method is deprecated. Use routes to build your nested NavGraph instead
static final void	<T extends Object> navigation(     @NonNull NavGraphBuilder receiver,     @NonNull Object startDestination,     @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,     @ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder ) Construct a nested NavGraph
static final void	<T extends Object> navigation(     @NonNull NavGraphBuilder receiver,     @NonNull KClass<@NonNull ?> startDestination,     @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,     @ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder ) Construct a nested NavGraph
static final void	navigation(     @NonNull NavGraphBuilder receiver,     @NonNull String startDestination,     @NonNull String route,     @ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder ) Construct a nested NavGraph
static final @NonNull NavGraph	navigation(     @NonNull NavigatorProvider receiver,     @IdRes int id,     @IdRes int startDestination,     @ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder ) This method is deprecated. Use routes to build your NavGraph instead
static final @NonNull NavGraph	navigation(     @NonNull NavigatorProvider receiver,     @NonNull String startDestination,     String route,     @ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder ) Construct a new NavGraph
static final @NonNull NavGraph	navigation(     @NonNull NavigatorProvider receiver,     @NonNull Object startDestination,     KClass<@NonNull ?> route,     @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,     @ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder ) Construct a new NavGraph
static final @NonNull NavGraph	navigation(     @NonNull NavigatorProvider receiver,     @NonNull KClass<@NonNull ?> startDestination,     KClass<@NonNull ?> route,     @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,     @ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder ) Construct a new NavGraph

Public methods

navigation

Artifact: androidx.navigation:navigation-common

View Source

Added in 1.0.0

public static final void navigation(
    @NonNull NavGraphBuilder receiver,
    @IdRes int id,
    @IdRes int startDestination,
    @ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder
)

This method is deprecated.
Use routes to build your nested NavGraph instead

Construct a nested NavGraph

Parameters
@IdRes int id	the destination's unique id
@IdRes int startDestination	the starting destination for this NavGraph
@ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder	the builder used to construct the graph

Returns
void	the newly constructed nested NavGraph

navigation

Artifact: androidx.navigation:navigation-common

View Source

public static final void <T extends Object> navigation(
    @NonNull NavGraphBuilder receiver,
    @NonNull Object startDestination,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
    @ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder
)

Construct a nested NavGraph

Parameters
<T extends Object>	the graph's unique route from a KClass
@NonNull Object startDestination	the starting destination's route from an Object for this NavGraph. The respective NavDestination must be added with route from a KClass in order to match.
@NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap	A mapping of KType to custom NavType<*> in the T. May be empty if T does not use custom NavTypes.
@ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder	the builder used to construct the graph

Returns
void	the newly constructed nested NavGraph

navigation

Artifact: androidx.navigation:navigation-common

View Source

public static final void <T extends Object> navigation(
    @NonNull NavGraphBuilder receiver,
    @NonNull KClass<@NonNull ?> startDestination,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
    @ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder
)

Construct a nested NavGraph

Parameters
<T extends Object>	the graph's unique route from a KClass
@NonNull KClass<@NonNull ?> startDestination	the starting destination's route from a KClass for this NavGraph. The respective NavDestination must be added with route from a KClass in order to match.
@NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap	A mapping of KType to custom NavType<*> in the T. May be empty if T does not use custom NavTypes.
@ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder	the builder used to construct the graph

Returns
void	the newly constructed nested NavGraph

navigation

Artifact: androidx.navigation:navigation-common

View Source

public static final void navigation(
    @NonNull NavGraphBuilder receiver,
    @NonNull String startDestination,
    @NonNull String route,
    @ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder
)

Construct a nested NavGraph

Parameters
@NonNull String startDestination	the starting destination's route for this NavGraph
@NonNull String route	the destination's unique route
@ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder	the builder used to construct the graph

Returns
void	the newly constructed nested NavGraph

navigation

Artifact: androidx.navigation:navigation-common

View Source

Added in 1.0.0

public static final @NonNull NavGraph navigation(
    @NonNull NavigatorProvider receiver,
    @IdRes int id,
    @IdRes int startDestination,
    @ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder
)

This method is deprecated.
Use routes to build your NavGraph instead

Construct a new NavGraph

Parameters
@IdRes int id	the destination's unique id
@IdRes int startDestination	the starting destination for this NavGraph
@ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder	the builder used to construct the graph

Returns
@NonNull NavGraph	the newly constructed NavGraph

navigation

Artifact: androidx.navigation:navigation-common

View Source

public static final @NonNull NavGraph navigation(
    @NonNull NavigatorProvider receiver,
    @NonNull String startDestination,
    String route,
    @ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder
)

Construct a new NavGraph

Parameters
@NonNull String startDestination	the starting destination's route for this NavGraph
String route	the destination's unique route
@ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder	the builder used to construct the graph

Returns
@NonNull NavGraph	the newly constructed NavGraph

navigation

Artifact: androidx.navigation:navigation-common

View Source

public static final @NonNull NavGraph navigation(
    @NonNull NavigatorProvider receiver,
    @NonNull Object startDestination,
    KClass<@NonNull ?> route,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
    @ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder
)

Construct a new NavGraph

Parameters
@NonNull Object startDestination	the starting destination's route from an Object for this NavGraph. The respective NavDestination must be added with route from a KClass in order to match.
KClass<@NonNull ?> route	the graph's unique route as a KClass
@NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap	A mapping of KType to custom NavType<*> in the route. May be empty if route does not use custom NavTypes.
@ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder	the builder used to construct the graph

Returns
@NonNull NavGraph	the newly constructed NavGraph

navigation

Artifact: androidx.navigation:navigation-common

View Source

public static final @NonNull NavGraph navigation(
    @NonNull NavigatorProvider receiver,
    @NonNull KClass<@NonNull ?> startDestination,
    KClass<@NonNull ?> route,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
    @ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder
)

Construct a new NavGraph

Parameters
@NonNull KClass<@NonNull ?> startDestination	the starting destination's route from a KClass for this NavGraph. The respective NavDestination must be added with route from a KClass in order to match.
KClass<@NonNull ?> route	the graph's unique route as a KClass
@NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap	A mapping of KType to custom NavType<*> in the route. May be empty if route does not use custom NavTypes.
@ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder	the builder used to construct the graph

Returns
@NonNull NavGraph	the newly constructed NavGraph