DialogNavigatorDestinationBuilder

Artifact: androidx.navigation:navigation-compose

Kotlin |Java

@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`
`@ExperimentalSafeArgsApi DialogNavigatorDestinationBuilder( navigator: DialogNavigator, route: KClass<>, typeMap: Map<KType, NavType<>>, dialogProperties: DialogProperties, content: @Composable (NavBackStackEntry) -> Unit )` DSL for constructing a new `DialogNavigator.Destination`

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

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.
`open DialogNavigator.Destination`	`build()` Build the NavDestination by calling `Navigator.createDestination`.
`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.

Inherited properties

From androidx.navigation.NavDestinationBuilder

`Int`	`id` The destination's unique ID.
`CharSequence?`	`label` The descriptive label of the destination
`Navigator<DialogNavigator.Destination>`	`navigator` The navigator the destination that will be used in `instantiateDestination` to create the destination.
`String?`	`route` The destination's unique route.

Public constructors

Added in 2.8.0-alpha07

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

Added in 2.8.0-alpha07

@ExperimentalSafeArgsApi
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

Added in 2.8.0-alpha07

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.