DynamicFragmentNavigator

@Navigator.Name(value = "fragment")
class DynamicFragmentNavigator : FragmentNavigator

kotlin.Any
   ↳ androidx.navigation.Navigator
     ↳ androidx.navigation.fragment.FragmentNavigator
       ↳ androidx.navigation.dynamicfeatures.fragment.DynamicFragmentNavigator

The Navigator that enables navigating to destinations within dynamic feature modules.

Summary

Nested types

Destination for dynamic feature navigator.

Public constructors
DynamicFragmentNavigator(
    context: Context,
    manager: FragmentManager,
    containerId: Int,
    installManager: DynamicInstallManager
)

Public functions
open DynamicFragmentNavigator.Destination
open Unit
navigate(
    entries: List<NavBackStackEntry>,
    navOptions: NavOptions?,
    navigatorExtras: Navigator.Extras?
)

{@inheritDoc}

Inherited functions
From androidx.navigation.fragment.FragmentNavigator
open Fragment
instantiateFragment(
    context: Context,
    fragmentManager: FragmentManager,
    className: String,
    args: Bundle?
)

This function is deprecated. Set a custom {@link androidx.fragment.app.FragmentFactory} via {@link FragmentManager#setFragmentFactory(FragmentFactory)} to control instantiation of Fragments.
open Unit
open Unit

{@inheritDoc}
open Unit
onRestoreState(savedState: Bundle)
open Bundle?
open Unit
popBackStack(popUpTo: NavBackStackEntry, savedState: Boolean)

{@inheritDoc}
From androidx.navigation.Navigator
open NavDestination?
navigate(
    destination: FragmentNavigator.Destination,
    args: SavedState?,
    navOptions: NavOptions?,
    navigatorExtras: Navigator.Extras?
)
open Unit
open Boolean

Inherited properties
From androidx.navigation.Navigator
Boolean
NavigatorState

Public constructors

DynamicFragmentNavigator

Added in 2.3.0
DynamicFragmentNavigator(
    context: Context,
    manager: FragmentManager,
    containerId: Int,
    installManager: DynamicInstallManager
)

Public functions

createDestination

Added in 2.3.0
open fun createDestination(): DynamicFragmentNavigator.Destination
 
open fun navigate(
    entries: List<NavBackStackEntry>,
    navOptions: NavOptions?,
    navigatorExtras: Navigator.Extras?
): Unit

{@inheritDoc}

This method should always call FragmentTransaction.setPrimaryNavigationFragment so that the Fragment associated with the new destination can be retrieved with FragmentManager.getPrimaryNavigationFragment.

Note that the default implementation commits the new Fragment asynchronously, so the new Fragment is not instantly available after this call completes.

This call will be ignored if the FragmentManager state has already been saved.