NavControllerKt

Added in 1.0.0

public final class NavControllerKt

Summary

Public methods
static final @NonNull NavGraph
createGraph(
    @NonNull NavController receiver,
    @IdRes int id,
    @IdRes int startDestination,
    @ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder
)

This method is deprecated. Use routes to create your NavGraph instead
static final @NonNull NavGraph
createGraph(
    @NonNull NavController receiver,
    @NonNull String startDestination,
    String route,
    @ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder
)

Construct a new NavGraph
static final @NonNull NavGraph
createGraph(
    @NonNull NavController 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
createGraph(
    @NonNull NavController 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

createGraph

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

Construct a new NavGraph

Parameters
@IdRes int id

the graph's unique id
@IdRes int startDestination

the route for the start destination
@ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder

the builder used to construct the graph

createGraph

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

Construct a new NavGraph

Parameters
@NonNull String startDestination

the route for the start destination
String route

the route for the graph
@ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder

the builder used to construct the graph

createGraph

public static final @NonNull NavGraph createGraph(
    @NonNull NavController 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 as a KClass in order to match.
KClass<@NonNull ?> route

the graph's unique route from 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

createGraph

public static final @NonNull NavGraph createGraph(
    @NonNull NavController 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 as a KClass in order to match.
KClass<@NonNull ?> route

the graph's unique route from 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