# FragmentNavigator

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

*** ** * ** ***


```
@Navigator.Name(value = "fragment")
open class FragmentNavigator : Navigator<FragmentNavigator.Destination>
```

<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)\<[FragmentNavigator.Destination](https://developer.android.com/reference/kotlin/androidx/navigation/fragment/FragmentNavigator.Destination)\> ||
|   | ↳ | [androidx.navigation.fragment.FragmentNavigator](https://developer.android.com/reference/kotlin/androidx/navigation/fragment/FragmentNavigator) |

Known direct subclasses [DynamicFragmentNavigator](https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/fragment/DynamicFragmentNavigator)

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/fragment/DynamicFragmentNavigator` | The `https://developer.android.com/reference/kotlin/androidx/navigation/Navigator` that enables navigating to destinations within dynamic feature modules. |

*** ** * ** ***

Navigator that navigates through `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction`. Every destination using this Navigator must set a valid Fragment class name with `android:name` or `https://developer.android.com/reference/kotlin/androidx/navigation/fragment/FragmentNavigator.Destination#setClassName(kotlin.String)`.

The current Fragment from FragmentNavigator's perspective can be retrieved by calling `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#getPrimaryNavigationFragment()` with the FragmentManager passed to this FragmentNavigator.

Note that the default implementation does Fragment transactions asynchronously, so the current Fragment will not be available immediately (i.e., in callbacks to `https://developer.android.com/reference/kotlin/androidx/navigation/NavController.OnDestinationChangedListener`).

FragmentNavigator respects `https://developer.android.com/reference/android/util/Log.html#isLoggable(java.lang.String, int)` for debug logging, allowing you to use `adb shell setprop log.tag.FragmentNavigator VERBOSE`.

## Summary

| ### Nested types |
|---|
| `@https://developer.android.com/reference/kotlin/androidx/navigation/NavDestination.ClassType(value = https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment) open class https://developer.android.com/reference/kotlin/androidx/navigation/fragment/FragmentNavigator.Destination : https://developer.android.com/reference/kotlin/androidx/navigation/NavDestination` NavDestination specific to `https://developer.android.com/reference/kotlin/androidx/navigation/fragment/FragmentNavigator` |
| `class https://developer.android.com/reference/kotlin/androidx/navigation/fragment/FragmentNavigator.Extras : https://developer.android.com/reference/kotlin/androidx/navigation/Navigator.Extras` Extras that can be passed to FragmentNavigator to enable Fragment specific behavior |
| `class https://developer.android.com/reference/kotlin/androidx/navigation/fragment/FragmentNavigator.Extras.Builder` Builder for constructing new `https://developer.android.com/reference/kotlin/androidx/navigation/fragment/FragmentNavigator.Extras` instances. |

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

| ### Public functions |
|---|---|
| `open https://developer.android.com/reference/kotlin/androidx/navigation/fragment/FragmentNavigator.Destination` | `https://developer.android.com/reference/kotlin/androidx/navigation/fragment/FragmentNavigator#createDestination()()` |
| `open 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: https://developer.android.com/reference/android/content/Context.html, fragmentManager: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager, className: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, args: 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 https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/navigation/fragment/FragmentNavigator#navigate(kotlin.collections.List,androidx.navigation.NavOptions,androidx.navigation.Navigator.Extras)( entries: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/navigation/NavBackStackEntry>, navOptions: https://developer.android.com/reference/kotlin/androidx/navigation/NavOptions?, navigatorExtras: https://developer.android.com/reference/kotlin/androidx/navigation/Navigator.Extras? )` {@inheritDoc} |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/navigation/fragment/FragmentNavigator#onAttach(androidx.navigation.NavigatorState)(state: https://developer.android.com/reference/kotlin/androidx/navigation/NavigatorState)` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/navigation/fragment/FragmentNavigator#onLaunchSingleTop(androidx.navigation.NavBackStackEntry)(backStackEntry: https://developer.android.com/reference/kotlin/androidx/navigation/NavBackStackEntry)` {@inheritDoc} |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/navigation/fragment/FragmentNavigator#onRestoreState(android.os.Bundle)(savedState: https://developer.android.com/reference/android/os/Bundle.html)` |
| `open https://developer.android.com/reference/android/os/Bundle.html?` | `https://developer.android.com/reference/kotlin/androidx/navigation/fragment/FragmentNavigator#onSaveState()()` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/navigation/fragment/FragmentNavigator#popBackStack(androidx.navigation.NavBackStackEntry,kotlin.Boolean)(popUpTo: https://developer.android.com/reference/kotlin/androidx/navigation/NavBackStackEntry, savedState: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)` {@inheritDoc} |

### Inherited functions

From [androidx.navigation.Navigator](https://developer.android.com/reference/kotlin/androidx/navigation/Navigator) `open https://developer.android.com/reference/kotlin/androidx/navigation/NavDestination?` `https://developer.android.com/reference/kotlin/androidx/navigation/Navigator#navigate(androidx.navigation.NavDestination,android.os.Bundle,androidx.navigation.NavOptions,androidx.navigation.Navigator.Extras)(
destination: https://developer.android.com/reference/kotlin/androidx/navigation/fragment/FragmentNavigator.Destination,
args: https://developer.android.com/reference/android/os/Bundle.html?,
navOptions: https://developer.android.com/reference/kotlin/androidx/navigation/NavOptions?,
navigatorExtras: https://developer.android.com/reference/kotlin/androidx/navigation/Navigator.Extras?
)` `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `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) `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `https://developer.android.com/reference/kotlin/androidx/navigation/Navigator#isAttached()` `https://developer.android.com/reference/kotlin/androidx/navigation/NavigatorState` `https://developer.android.com/reference/kotlin/androidx/navigation/Navigator#state()`

## Public constructors

### FragmentNavigator

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

```
FragmentNavigator(
    context: Context,
    fragmentManager: FragmentManager,
    containerId: Int
)
```

## Public functions

### createDestination

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

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

### instantiateFragment

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

```
open fun [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,
    fragmentManager: FragmentManager,
    className: String,
    args: Bundle?
): Fragment
```

> [!CAUTION]
> **This function is deprecated.**   
> Set a custom {@link androidx.fragment.app.FragmentFactory} via {@link FragmentManager#setFragmentFactory(FragmentFactory)} to control instantiation of Fragments.

Instantiates the Fragment via the FragmentManager's `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentFactory`.

Note that this method is **not** responsible for calling `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment#setArguments(android.os.Bundle)` on the returned Fragment instance.

| Parameters |
|---|---|
| `context: https://developer.android.com/reference/android/content/Context.html` | Context providing the correct `https://developer.android.com/reference/java/lang/ClassLoader.html` |
| `fragmentManager: https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager` | FragmentManager the Fragment will be added to |
| `className: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The Fragment to instantiate |
| `args: https://developer.android.com/reference/android/os/Bundle.html?` | The Fragment's arguments, if any |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment` | A new fragment instance. |

### navigate

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

{@inheritDoc}

This method should always call `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction#setPrimaryNavigationFragment(androidx.fragment.app.Fragment)` so that the Fragment associated with the new destination can be retrieved with `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.

### onAttach

```
open fun onAttach(state: NavigatorState): Unit
```

### onLaunchSingleTop

```
open fun onLaunchSingleTop(backStackEntry: NavBackStackEntry): Unit
```

{@inheritDoc}

This method should always call `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction#setPrimaryNavigationFragment(androidx.fragment.app.Fragment)` so that the Fragment associated with the new destination can be retrieved with `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.

### onRestoreState

```
open fun onRestoreState(savedState: Bundle): Unit
```

### onSaveState

```
open fun onSaveState(): Bundle?
```

### popBackStack

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

{@inheritDoc}

This method must call `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentTransaction#setPrimaryNavigationFragment(androidx.fragment.app.Fragment)` if the pop succeeded so that the newly visible Fragment can be retrieved with `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentManager#getPrimaryNavigationFragment()`.

Note that the default implementation pops the Fragment asynchronously, so the newly visible Fragment from the back stack is not instantly available after this call completes.