# DynamicFragmentNavigator

# DynamicFragmentNavigator

Artifact:[androidx.navigation:navigation-dynamic-features-fragment](https://developer.android.com/jetpack/androidx/releases/navigation)  
[View Source](https://cs.android.com/search?q=file:androidx/navigation/dynamicfeatures/fragment/DynamicFragmentNavigator.kt+class:androidx.navigation.dynamicfeatures.fragment.DynamicFragmentNavigator)  
Added in[2.3.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.3.0)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/navigation/dynamicfeatures/fragment/DynamicFragmentNavigator "View this page in Java")

<br />

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

<br />

|---|---|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html)                                                                                                                     ||||
| ↳ | [androidx.navigation.Navigator](https://developer.android.com/reference/kotlin/androidx/navigation/Navigator)                                                                                       |||
|   | ↳ | [androidx.navigation.fragment.FragmentNavigator](https://developer.android.com/reference/kotlin/androidx/navigation/fragment/FragmentNavigator)                                                  ||
|   |   | ↳ | [androidx.navigation.dynamicfeatures.fragment.DynamicFragmentNavigator](https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/fragment/DynamicFragmentNavigator) |

*** ** * ** ***

The[Navigator](https://developer.android.com/reference/kotlin/androidx/navigation/Navigator)that enables navigating to destinations within dynamic feature modules.

## Summary

|                                                                                                                                                                              ### Nested types                                                                                                                                                                              |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `class `[DynamicFragmentNavigator.Destination](https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/fragment/DynamicFragmentNavigator.Destination)` : `[FragmentNavigator.Destination](https://developer.android.com/reference/kotlin/androidx/navigation/fragment/FragmentNavigator.Destination) Destination for dynamic feature navigator. |

|                                                                                                                                                                                                                                                                                                                                                                                    ### Public constructors                                                                                                                                                                                                                                                                                                                                                                                     |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [DynamicFragmentNavigator](https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/fragment/DynamicFragmentNavigator#DynamicFragmentNavigator(android.content.Context,androidx.fragment.app.FragmentManager,kotlin.Int,androidx.navigation.dynamicfeatures.DynamicInstallManager))`(` ` context: `[Context](https://developer.android.com/reference/android/content/Context.html)`,` ` manager: `[FragmentManager](https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager)`,` ` containerId: `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`,` ` installManager: `[DynamicInstallManager](https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicInstallManager) `)` |

|                                                                              ### Public functions                                                                               |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `open `[DynamicFragmentNavigator.Destination](https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/fragment/DynamicFragmentNavigator.Destination) | [createDestination](https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/fragment/DynamicFragmentNavigator#createDestination())`()`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `open `[Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)                                                                                            | [navigate](https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/fragment/DynamicFragmentNavigator#navigate(kotlin.collections.List,androidx.navigation.NavOptions,androidx.navigation.Navigator.Extras))`(` ` entries: `[List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[NavBackStackEntry](https://developer.android.com/reference/kotlin/androidx/navigation/NavBackStackEntry)`>,` ` navOptions: `[NavOptions](https://developer.android.com/reference/kotlin/androidx/navigation/NavOptions)`?,` ` navigatorExtras: `[Navigator.Extras](https://developer.android.com/reference/kotlin/androidx/navigation/Navigator.Extras)`?` `)` {@inheritDoc} |

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ### Inherited functions                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From[androidx.navigation.fragment.FragmentNavigator](https://developer.android.com/reference/kotlin/androidx/navigation/fragment/FragmentNavigator) |--------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `open `[Fragment](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment) | ~~[instantiateFragment](https://developer.android.com/reference/kotlin/androidx/navigation/fragment/FragmentNavigator#instantiateFragment(android.content.Context,androidx.fragment.app.FragmentManager,kotlin.String,android.os.Bundle))~~`(` ` context: `[Context](https://developer.android.com/reference/android/content/Context.html)`,` ` fragmentManager: `[FragmentManager](https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager)`,` ` className: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`,` ` args: `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)`?` `)` **This function is deprecated.**Set a custom {@link androidx.fragment.app.FragmentFactory} via {@link FragmentManager#setFragmentFactory(FragmentFactory)} to control instantiation of Fragments. | | `open `[Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)             | [onAttach](https://developer.android.com/reference/kotlin/androidx/navigation/fragment/FragmentNavigator#onAttach(androidx.navigation.NavigatorState))`(state: `[NavigatorState](https://developer.android.com/reference/kotlin/androidx/navigation/NavigatorState)`)`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | | `open `[Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)             | [onLaunchSingleTop](https://developer.android.com/reference/kotlin/androidx/navigation/fragment/FragmentNavigator#onLaunchSingleTop(androidx.navigation.NavBackStackEntry))`(backStackEntry: `[NavBackStackEntry](https://developer.android.com/reference/kotlin/androidx/navigation/NavBackStackEntry)`)` {@inheritDoc}                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | | `open `[Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)             | [onRestoreState](https://developer.android.com/reference/kotlin/androidx/navigation/fragment/FragmentNavigator#onRestoreState(android.os.Bundle))`(savedState: `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)`)`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | | `open `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)`?`               | [onSaveState](https://developer.android.com/reference/kotlin/androidx/navigation/fragment/FragmentNavigator#onSaveState())`()`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | | `open `[Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)             | [popBackStack](https://developer.android.com/reference/kotlin/androidx/navigation/fragment/FragmentNavigator#popBackStack(androidx.navigation.NavBackStackEntry,kotlin.Boolean))`(popUpTo: `[NavBackStackEntry](https://developer.android.com/reference/kotlin/androidx/navigation/NavBackStackEntry)`, savedState: `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)`)` {@inheritDoc}                                                                                                                                                                                                                                                                                                                                                                                                                                                  | |
| From[androidx.navigation.Navigator](https://developer.android.com/reference/kotlin/androidx/navigation/Navigator) |---------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `open `[NavDestination](https://developer.android.com/reference/kotlin/androidx/navigation/NavDestination)`?` | [navigate](https://developer.android.com/reference/kotlin/androidx/navigation/Navigator#navigate(androidx.navigation.fragment.FragmentNavigator.Destination,androidx.savedstate.SavedState,androidx.navigation.NavOptions,androidx.navigation.Navigator.Extras))`(` ` destination: `[FragmentNavigator.Destination](https://developer.android.com/reference/kotlin/androidx/navigation/fragment/FragmentNavigator.Destination)`,` ` args: `[SavedState](https://developer.android.com/reference/kotlin/androidx/savedstate/SavedState)`?,` ` navOptions: `[NavOptions](https://developer.android.com/reference/kotlin/androidx/navigation/NavOptions)`?,` ` navigatorExtras: `[Navigator.Extras](https://developer.android.com/reference/kotlin/androidx/navigation/Navigator.Extras)`?` `)` | | `open `[Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)                          | [onRestoreState](https://developer.android.com/reference/kotlin/androidx/navigation/Navigator#onRestoreState(androidx.savedstate.SavedState))`(savedState: `[SavedState](https://developer.android.com/reference/kotlin/androidx/savedstate/SavedState)`)`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | | `open `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)                    | [popBackStack](https://developer.android.com/reference/kotlin/androidx/navigation/Navigator#popBackStack())`()`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |

|                                                                                                                                                                                                                                                                                                                                                                        ### Inherited properties                                                                                                                                                                                                                                                                                                                                                                         |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From[androidx.navigation.Navigator](https://developer.android.com/reference/kotlin/androidx/navigation/Navigator) |-----------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------| | [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)                 | [isAttached](https://developer.android.com/reference/kotlin/androidx/navigation/Navigator#isAttached()) | | [NavigatorState](https://developer.android.com/reference/kotlin/androidx/navigation/NavigatorState) | [state](https://developer.android.com/reference/kotlin/androidx/navigation/Navigator#state())           | |

## Public constructors

### DynamicFragmentNavigator

Added in[2.3.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.3.0)  

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

## Public functions

### createDestination

Added in[2.3.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.3.0)  

```
open fun createDestination(): DynamicFragmentNavigator.Destination
```  

### navigate

```
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](https://developer.android.com/reference/kotlin/androidx/fragment/app/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.