/
Android Studio Sign in

DialogNavigator
kotlin.Any
   ↳ androidx.navigation.Navigator
     ↳ androidx.navigation.compose.DialogNavigator

Navigator that navigates through Composables that will be hosted within a Dialog. Every destination using this Navigator must set a valid Composable by setting it directly on an instantiated Destination or calling dialog.

Summary

Nested types

NavDestination specific to DialogNavigator

Public constructors
Cmn

Public functions
open DialogNavigator.Destination

Construct a new NavDestination associated with this Navigator.
Cmn
open Unit
navigate(
    entries: List<NavBackStackEntry>,
    navOptions: NavOptions?,
    navigatorExtras: Navigator.Extras?
)

Navigate to a destination.
Cmn
open Unit
popBackStack(popUpTo: NavBackStackEntry, savedState: Boolean)

Attempt to pop this navigator's back stack, performing the appropriate navigation.
Cmn

Inherited functions
From androidx.navigation.Navigator
open NavDestination?
navigate(
    destination: DialogNavigator.Destination,
    args: SavedState?,
    navOptions: NavOptions?,
    navigatorExtras: Navigator.Extras?
)

Navigate to a destination.
Cmn
open Unit

Indicator that this Navigator is actively being used by a NavController.
Cmn
open Unit

Informational callback indicating that the given backStackEntry has been affected by a NavOptions.shouldLaunchSingleTop operation.
Cmn
open Unit

Restore any state previously saved in onSaveState.
Cmn
open SavedState?

Called to ask for a SavedState representing the Navigator's state.
Cmn
open Boolean

Attempt to pop this navigator's back stack, performing the appropriate navigation.
Cmn

Inherited properties
From androidx.navigation.Navigator
Boolean

Whether this Navigator is actively being used by a NavController.
Cmn
NavigatorState

The state of the Navigator is the communication conduit between the Navigator and the NavController that has called onAttach.
Cmn

Public constructors

DialogNavigator

Cmn
Added in 2.4.0
DialogNavigator()

Public functions

createDestination

Cmn
Added in 2.4.0
open fun createDestination(): DialogNavigator.Destination

Construct a new NavDestination associated with this Navigator.

Any initialization of the destination should be done in the destination's constructor as it is not guaranteed that every destination will be created through this method.

Returns
DialogNavigator.Destination

a new NavDestination
Cmn 
open fun navigate(
    entries: List<NavBackStackEntry>,
    navOptions: NavOptions?,
    navigatorExtras: Navigator.Extras?
): Unit

Navigate to a destination.

Requests navigation to a given destination associated with this navigator in the navigation graph. This method generally should not be called directly; NavController will delegate to it when appropriate.

Parameters
entries: List<NavBackStackEntry>

destination(s) to navigate to
navOptions: NavOptions?

additional options for navigation
navigatorExtras: Navigator.Extras?

extras unique to your Navigator.

popBackStack

Cmn 
open fun popBackStack(popUpTo: NavBackStackEntry, savedState: Boolean): Unit

Attempt to pop this navigator's back stack, performing the appropriate navigation.

All destinations back to popUpTo should be popped off the back stack.

Parameters
popUpTo: NavBackStackEntry

the entry that should be popped off the NavigatorState.backStack along with all entries above this entry.
savedState: Boolean

whether any Navigator specific state associated with popUpTo should be saved to later be restored by a call to navigate with NavOptions.shouldRestoreState.
Morty Proxy This is a proxified and sanitized view of the page, visit original site.