DialogNavigatorDestinationBuilder

Artifact: androidx.navigation:navigation-compose

View Source

Added in 2.8.0

Common/AllAndroid/JVM

• Cmn

  @NavDestinationDsl
  class DialogNavigatorDestinationBuilder : NavDestinationBuilder

kotlin.Any
↳	androidx.navigation.NavDestinationBuilder
	↳	androidx.navigation.compose.DialogNavigatorDestinationBuilder

---

DSL for constructing a new DialogNavigator.Destination

Summary

Public constructors
DialogNavigatorDestinationBuilder(     navigator: DialogNavigator,     route: String,     dialogProperties: DialogProperties,     content: @Composable (NavBackStackEntry) -> Unit ) DSL for constructing a new DialogNavigator.Destination	Cmn
DialogNavigatorDestinationBuilder(     navigator: DialogNavigator,     route: KClass<*>,     typeMap: Map<KType, NavType<*>>,     dialogProperties: DialogProperties,     content: @Composable (NavBackStackEntry) -> Unit ) DSL for constructing a new DialogNavigator.Destination	Cmn

Protected functions
open DialogNavigator.Destination	instantiateDestination() Instantiate a new instance of D that will be passed to build.	Cmn

Inherited functions

From androidx.navigation.NavDestinationBuilder Unit argument(name: String, argumentBuilder: NavArgumentBuilder.() -> Unit) Add a NavArgument to this destination. Cmn Unit argument(name: String, argument: NavArgument) Add a NavArgument to this destination. Cmn open DialogNavigator.Destination build() Build the NavDestination by calling Navigator.createDestination. Cmn inline Unit <T : Any> deepLink(basePath: String) Add a deep link to this destination. Cmn Unit deepLink(navDeepLink: NavDeepLinkDslBuilder.() -> Unit) Add a deep link to this destination. Cmn Unit deepLink(navDeepLink: NavDeepLink) Add a deep link to this destination. Cmn Unit deepLink(uriPattern: String) Add a deep link to this destination. Cmn inline Unit <T : Any> deepLink(basePath: String, noinline navDeepLink: NavDeepLinkDslBuilder.() -> Unit) Add a deep link to this destination. Cmn Unit <T : Any> deepLink(route: KClass<T>, basePath: String, navDeepLink: NavDeepLinkDslBuilder.() -> Unit) Add a deep link to this destination. Cmn

Inherited properties
From androidx.navigation.NavDestinationBuilder CharSequence? label The descriptive label of the destination Cmn Navigator<DialogNavigator.Destination> navigator The navigator the destination that will be used in instantiateDestination to create the destination. Cmn String? route The destination's unique route. Cmn

Public constructors

DialogNavigatorDestinationBuilder

Cmn

Added in 2.8.0

DialogNavigatorDestinationBuilder(
    navigator: DialogNavigator,
    route: String,
    dialogProperties: DialogProperties,
    content: @Composable (NavBackStackEntry) -> Unit
)

DSL for constructing a new DialogNavigator.Destination

Parameters
navigator: DialogNavigator	navigator used to create the destination
route: String	the destination's unique route
dialogProperties: DialogProperties	properties that should be passed to androidx.compose.ui.window.Dialog.
content: @Composable (NavBackStackEntry) -> Unit	composable for the destination

DialogNavigatorDestinationBuilder

Cmn

Added in 2.8.0

DialogNavigatorDestinationBuilder(
    navigator: DialogNavigator,
    route: KClass<*>,
    typeMap: Map<KType, NavType<*>>,
    dialogProperties: DialogProperties,
    content: @Composable (NavBackStackEntry) -> Unit
)

DSL for constructing a new DialogNavigator.Destination

Parameters
navigator: DialogNavigator	navigator used to create the destination
route: KClass<*>	the destination's unique route from a KClass
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.
dialogProperties: DialogProperties	properties that should be passed to androidx.compose.ui.window.Dialog.
content: @Composable (NavBackStackEntry) -> Unit	composable for the destination

Protected functions

instantiateDestination

Cmn

Added in 2.8.0

protected open fun instantiateDestination(): DialogNavigator.Destination

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

By default, this calls Navigator.createDestination on navigator, but can be overridden to call a custom constructor, etc.