DynamicFragmentNavigatorDestinationBuilder

@NavDestinationDsl
class DynamicFragmentNavigatorDestinationBuilder : NavDestinationBuilder

kotlin.Any
   ↳ androidx.navigation.NavDestinationBuilder
     ↳ androidx.navigation.dynamicfeatures.fragment.DynamicFragmentNavigatorDestinationBuilder

DSL for constructing a new DynamicFragmentNavigator.Destination

Summary

Public constructors
DynamicFragmentNavigatorDestinationBuilder(
    navigator: DynamicFragmentNavigator,
    id: @IdRes Int,
    fragmentClassName: String
)

This function is deprecated. Use routes to create your DynamicFragmentDestinationBuilder instead
DynamicFragmentNavigatorDestinationBuilder(
    navigator: DynamicFragmentNavigator,
    route: String,
    fragmentClassName: String
)
DynamicFragmentNavigatorDestinationBuilder(
    navigator: DynamicFragmentNavigator,
    route: KClass<*>,
    typeMap: Map<KType, NavType<*>>,
    fragmentClassName: String
)

DSL for constructing a new DynamicFragmentNavigator.Destination

Public functions
open DynamicFragmentNavigator.Destination

Build the NavDestination by calling Navigator.createDestination.

Public properties
String?

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

DynamicFragmentNavigatorDestinationBuilder

Added in 2.3.0
Deprecated in 2.4.0
DynamicFragmentNavigatorDestinationBuilder(
    navigator: DynamicFragmentNavigator,
    id: @IdRes Int,
    fragmentClassName: String
)

DynamicFragmentNavigatorDestinationBuilder

Added in 2.4.0
DynamicFragmentNavigatorDestinationBuilder(
    navigator: DynamicFragmentNavigator,
    route: String,
    fragmentClassName: String
)

DynamicFragmentNavigatorDestinationBuilder

Added in 2.8.0
DynamicFragmentNavigatorDestinationBuilder(
    navigator: DynamicFragmentNavigator,
    route: KClass<*>,
    typeMap: Map<KType, NavType<*>>,
    fragmentClassName: String
)

DSL for constructing a new DynamicFragmentNavigator.Destination

Parameters
navigator: DynamicFragmentNavigator

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

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.
fragmentClassName: String

Fully qualified class name of destination Fragment.

Public functions

build

Added in 2.3.0
open fun build(): DynamicFragmentNavigator.Destination

Build the NavDestination by calling Navigator.createDestination.

Public properties

moduleName

Added in 2.3.0
var moduleName: String?