# DialogFragmentNavigator

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/DialogFragmentNavigator.kt+class:androidx.navigation.fragment.DialogFragmentNavigator) Added in [2.1.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.1.0)

*** ** * ** ***


```
@Navigator.Name(value = "dialog")
public final class DialogFragmentNavigator extends Navigator<@NonNull DialogFragmentNavigator.Destination>
```

<br />

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) |||
| ↳ | [androidx.navigation.Navigator](https://developer.android.com/reference/androidx/navigation/Navigator)\<@[NonNull](https://developer.android.com/reference/androidx/annotation/NonNull) [DialogFragmentNavigator.Destination](https://developer.android.com/reference/androidx/navigation/fragment/DialogFragmentNavigator.Destination)\> ||
|   | ↳ | [androidx.navigation.fragment.DialogFragmentNavigator](https://developer.android.com/reference/androidx/navigation/fragment/DialogFragmentNavigator) |

*** ** * ** ***

Navigator that uses `https://developer.android.com/reference/androidx/fragment/app/DialogFragment#show(androidx.fragment.app.FragmentManager,java.lang.String)`. Every destination using this Navigator must set a valid DialogFragment class name with `android:name` or `https://developer.android.com/reference/androidx/navigation/fragment/DialogFragmentNavigator.Destination#setClassName(kotlin.String)`.

## Summary

| ### Nested types |
|---|
| `@https://developer.android.com/reference/androidx/navigation/NavDestination.ClassType(value = https://developer.android.com/reference/androidx/fragment/app/DialogFragment) public class https://developer.android.com/reference/androidx/navigation/fragment/DialogFragmentNavigator.Destination extends https://developer.android.com/reference/androidx/navigation/NavDestination implements https://developer.android.com/reference/androidx/navigation/FloatingWindow` NavDestination specific to `https://developer.android.com/reference/androidx/navigation/fragment/DialogFragmentNavigator`. |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/navigation/fragment/DialogFragmentNavigator#DialogFragmentNavigator(android.content.Context,androidx.fragment.app.FragmentManager)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/Context.html context, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/fragment/app/FragmentManager fragmentManager )` |

| ### Public methods |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/fragment/DialogFragmentNavigator.Destination` | `https://developer.android.com/reference/androidx/navigation/fragment/DialogFragmentNavigator#createDestination()()` |
| `void` | `https://developer.android.com/reference/androidx/navigation/fragment/DialogFragmentNavigator#navigate(kotlin.collections.List,androidx.navigation.NavOptions,androidx.navigation.Navigator.Extras)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavBackStackEntry> entries, https://developer.android.com/reference/androidx/navigation/NavOptions navOptions, https://developer.android.com/reference/androidx/navigation/Navigator.Extras navigatorExtras )` |
| `void` | `https://developer.android.com/reference/androidx/navigation/fragment/DialogFragmentNavigator#onAttach(androidx.navigation.NavigatorState)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavigatorState state)` |
| `void` | `https://developer.android.com/reference/androidx/navigation/fragment/DialogFragmentNavigator#onLaunchSingleTop(androidx.navigation.NavBackStackEntry)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavBackStackEntry backStackEntry)` |
| `void` | `https://developer.android.com/reference/androidx/navigation/fragment/DialogFragmentNavigator#popBackStack(androidx.navigation.NavBackStackEntry,kotlin.Boolean)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavBackStackEntry popUpTo, boolean savedState)` |

### Inherited methods

From [androidx.navigation.Navigator](https://developer.android.com/reference/androidx/navigation/Navigator) `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavigatorState` `https://developer.android.com/reference/androidx/navigation/Navigator#getState()()` `final boolean` `https://developer.android.com/reference/androidx/navigation/Navigator#isAttached()()` `https://developer.android.com/reference/androidx/navigation/NavDestination` `https://developer.android.com/reference/androidx/navigation/Navigator#navigate(androidx.navigation.NavDestination,android.os.Bundle,androidx.navigation.NavOptions,androidx.navigation.Navigator.Extras)(
@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/fragment/DialogFragmentNavigator.Destination destination,
https://developer.android.com/reference/android/os/Bundle.html args,
https://developer.android.com/reference/androidx/navigation/NavOptions navOptions,
https://developer.android.com/reference/androidx/navigation/Navigator.Extras navigatorExtras
)` `void` `https://developer.android.com/reference/androidx/navigation/Navigator#onRestoreState(android.os.Bundle)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/Bundle.html savedState)` `https://developer.android.com/reference/android/os/Bundle.html` `https://developer.android.com/reference/androidx/navigation/Navigator#onSaveState()()` `boolean` `https://developer.android.com/reference/androidx/navigation/Navigator#popBackStack()()`

## Public constructors

### DialogFragmentNavigator

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

```
public DialogFragmentNavigator(
    @NonNull Context context,
    @NonNull FragmentManager fragmentManager
)
```

## Public methods

### createDestination

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

```
public @NonNull DialogFragmentNavigator.Destination createDestination()
```

### navigate

```
public void navigate(
    @NonNull List<@NonNull NavBackStackEntry> entries,
    NavOptions navOptions,
    Navigator.Extras navigatorExtras
)
```

### onAttach

```
public void onAttach(@NonNull NavigatorState state)
```

### onLaunchSingleTop

```
public void onLaunchSingleTop(@NonNull NavBackStackEntry backStackEntry)
```

### popBackStack

```
public void popBackStack(@NonNull NavBackStackEntry popUpTo, boolean savedState)
```