FragmentNavigatorDestinationBuilder

@NavDestinationDsl
class FragmentNavigatorDestinationBuilder : NavDestinationBuilder

kotlin.Any
   ↳ androidx.navigation.NavDestinationBuilder
     ↳ androidx.navigation.fragment.FragmentNavigatorDestinationBuilder

DSL for constructing a new FragmentNavigator.Destination

Summary

Public constructors
FragmentNavigatorDestinationBuilder(
    navigator: FragmentNavigator,
    id: @IdRes Int,
    fragmentClass: KClass<Fragment>
)

This function is deprecated. Use routes to build your FragmentNavigatorDestination instead
FragmentNavigatorDestinationBuilder(
    navigator: FragmentNavigator,
    route: String,
    fragmentClass: KClass<Fragment>
)

DSL for constructing a new FragmentNavigator.Destination
FragmentNavigatorDestinationBuilder(
    navigator: FragmentNavigator,
    route: KClass<Any>,
    typeMap: Map<KType, NavType<*>>,
    fragmentClass: KClass<Fragment>
)

DSL for constructing a new FragmentNavigator.Destination

Public functions
open FragmentNavigator.Destination

Build the NavDestination by calling Navigator.createDestination.

Inherited functions
From androidx.navigation.NavDestinationBuilder
Unit
action(actionId: Int, actionBuilder: NavActionBuilder.() -> Unit)

This function is deprecated. Building NavDestinations using IDs with the Kotlin DSL has been deprecated in favor of using routes.
Unit
argument(name: String, argumentBuilder: NavArgumentBuilder.() -> Unit)

Add a NavArgument to this destination.
Unit
argument(name: String, argument: NavArgument)

Add a NavArgument to this destination.
inline Unit
<T : Any> deepLink(basePath: String)

Add a deep link to this destination.
Unit
deepLink(navDeepLink: NavDeepLinkDslBuilder.() -> Unit)

Add a deep link to this destination.
Unit
deepLink(navDeepLink: NavDeepLink)

Add a deep link to this destination.
Unit
deepLink(uriPattern: String)

Add a deep link to this destination.
inline Unit
<T : Any> deepLink(basePath: String, noinline navDeepLink: NavDeepLinkDslBuilder.() -> Unit)

Add a deep link to this destination.
Unit
<T : Any> deepLink(route: KClass<T>, basePath: String, navDeepLink: NavDeepLinkDslBuilder.() -> Unit)

Add a deep link to this destination.
open FragmentNavigator.Destination

Instantiate a new instance of D that will be passed to build.

Inherited properties
From androidx.navigation.NavDestinationBuilder
Int

The destination's unique ID.
CharSequence?

The descriptive label of the destination
Navigator<FragmentNavigator.Destination>

The navigator the destination that will be used in instantiateDestination to create the destination.
String?

The destination's unique route.

Public constructors

FragmentNavigatorDestinationBuilder

Added in 2.0.0
FragmentNavigatorDestinationBuilder(
    navigator: FragmentNavigator,
    id: @IdRes Int,
    fragmentClass: KClass<Fragment>
)

DSL for constructing a new FragmentNavigator.Destination

Parameters
navigator: FragmentNavigator

navigator used to create the destination
id: @IdRes Int

the destination's unique id
fragmentClass: KClass<Fragment>

The class name of the Fragment to show when you navigate to this destination

FragmentNavigatorDestinationBuilder

FragmentNavigatorDestinationBuilder(
    navigator: FragmentNavigator,
    route: String,
    fragmentClass: KClass<Fragment>
)

DSL for constructing a new FragmentNavigator.Destination

Parameters
navigator: FragmentNavigator

navigator used to create the destination
route: String

the destination's unique route
fragmentClass: KClass<Fragment>

The class name of the Fragment to show when you navigate to this destination

FragmentNavigatorDestinationBuilder

FragmentNavigatorDestinationBuilder(
    navigator: FragmentNavigator,
    route: KClass<Any>,
    typeMap: Map<KType, NavType<*>>,
    fragmentClass: KClass<Fragment>
)

DSL for constructing a new FragmentNavigator.Destination

Parameters
navigator: FragmentNavigator

navigator used to create the destination
route: KClass<Any>

the route from a KClass of the destination
typeMap: Map<KType, NavType<*>>

map of destination arguments' kotlin type KType to its respective custom NavType. May be empty if route does not use custom NavTypes.
fragmentClass: KClass<Fragment>

The class name of the Fragment to show when you navigate to this destination

Public functions

build

Added in 1.0.0
open fun build(): FragmentNavigator.Destination

Build the NavDestination by calling Navigator.createDestination.