NavGraph

fun NavGraph.findStartDestination(): NavDestination

Finds the actual start destination of the graph, handling cases where the graph's starting destination is itself a NavGraph.

fun addAll(other: NavGraph): Unit

Add all destinations from another collection to this one. As each destination has at most one parent, the destinations will be removed from the given NavGraph.

fun addDestination(node: NavDestination): Unit

Adds a destination to this NavGraph. The destination must have an NavDestination.id id} set.

The destination must not have a parent set. If the destination is already part of a navigation graph, call remove before calling this method.

fun addDestinations(nodes: Collection<NavDestination?>): Unit

Adds multiple destinations to this NavGraph. Each destination must have an NavDestination.id id} set.

Each destination must not have a parent set. If any destination is already part of a navigation graph, call remove before calling this method.

fun addDestinations(vararg nodes: NavDestination): Unit

Adds multiple destinations to this NavGraph. Each destination must have an NavDestination.id id} set.

Each destination must not have a parent set. If any destination is already part of a navigation graph, call remove before calling this method.

fun clear(): Unit

Clear all destinations from this navigation graph.

inline fun <T : Any?> findNode(): NavDestination?

Finds a destination in the collection by route from KClass. This will recursively check the parent of this navigation graph if node is not found in this navigation graph.

fun findNode(resId: @IdRes Int): NavDestination?

Finds a destination in the collection by ID. This will recursively check the parent of this navigation graph if node is not found in this navigation graph.

fun findNode(route: KClass<*>): NavDestination?

Finds a destination in the collection by route from KClass. This will recursively check the parent of this navigation graph if node is not found in this navigation graph.

fun <T : Any?> findNode(route: T?): NavDestination?

Finds a destination in the collection by route from Object. This will recursively check the parent of this navigation graph if node is not found in this navigation graph.

fun findNode(route: String?): NavDestination?

Finds a destination in the collection by route. This will recursively check the parent of this navigation graph if node is not found in this navigation graph.

fun findNodeComprehensive(
    resId: Int,
    lastVisited: NavDestination?,
    searchChildren: Boolean,
    matchingDest: NavDestination? = null
): NavDestination?

Searches all children and parents recursively.

Does not revisit graphs (whether it's a child or parent) if it has already been visited.

fun getStartDestination(): @IdRes Int

Gets the starting destination for this NavGraph. When navigating to the NavGraph, this destination is the one the user will initially see.

open fun onInflate(context: Context, attrs: AttributeSet): Unit

Called when inflating a destination from a resource.

fun remove(node: NavDestination): Unit

Remove a given destination from this NavGraph

inline fun <T : Any> setStartDestination(): Unit

Sets the starting destination for this NavGraph.

This will override any previously set startDestinationId

fun setStartDestination(startDestId: Int): Unit

Sets the starting destination for this NavGraph.

This will clear any previously set startDestinationRoute.

fun <T : Any> setStartDestination(startDestRoute: KClass<T>): Unit

Sets the starting destination for this NavGraph.

This will override any previously set startDestinationId

fun <T : Any> setStartDestination(startDestRoute: T): Unit

Sets the starting destination for this NavGraph.

This will override any previously set startDestinationId

fun setStartDestination(startDestRoute: String): Unit

Sets the starting destination for this NavGraph.

This will override any previously set startDestinationId

val startDestinationId: Int

The starting destination id for this NavGraph. When navigating to the NavGraph, the destination represented by this id is the one the user will initially see.

val startDestinationRoute: String?

The route for the starting destination for this NavGraph. When navigating to the NavGraph, the destination represented by this route is the one the user will initially see.

operator fun NavGraph.contains(id: @IdRes Int): Boolean

Returns true if a destination with id is found in this navigation graph.

inline operator fun <T : Any> NavGraph.contains(route: KClass<T>): Boolean

Returns true if a destination with route is found in this navigation graph.

operator fun NavGraph.contains(route: String): Boolean

Returns true if a destination with route is found in this navigation graph.

operator fun <T : Any> NavGraph.contains(route: T): Boolean

Returns true if a destination with route is found in this navigation graph.

inline operator fun NavGraph.get(id: @IdRes Int): NavDestination

Returns the destination with id.

inline operator fun <T : Any> NavGraph.get(route: KClass<T>): NavDestination

Returns the destination with route from KClass.

inline operator fun NavGraph.get(route: String): NavDestination

Returns the destination with route.

inline operator fun <T : Any> NavGraph.get(route: T): NavDestination

Returns the destination with route from an Object.

inline operator fun NavGraph.minusAssign(node: NavDestination): Unit

Removes node from this navigation graph.

inline operator fun NavGraph.plusAssign(node: NavDestination): Unit

Adds a destination to this NavGraph. The destination must have an id set.

The destination must not have a parent set. If the destination is already part of a NavGraph, call NavGraph.remove before calling this method.

inline operator fun NavGraph.plusAssign(other: NavGraph): Unit

Add all destinations from another collection to this one. As each destination has at most one parent, the destinations will be removed from the given NavGraph.