# PopUpToBuilder

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

*** ** * ** ***

Kotlin \|[Java](https://developer.android.com/reference/androidx/navigation/PopUpToBuilder "View this page in Java") Common/AllAndroid/JVMJavaScript
- Cmn

  ```
  @NavOptionsDsl
  class PopUpToBuilder
  ```

*** ** * ** ***

DSL for customizing `https://developer.android.com/reference/kotlin/androidx/navigation/NavOptionsBuilder#popUpTo(kotlin.String,kotlin.Function1)` operations.

## Summary

| ### Public constructors |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/navigation/PopUpToBuilder#PopUpToBuilder()()` | Cmn |

| ### Public properties |
|---|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/navigation/PopUpToBuilder#inclusive()` Whether the `popUpTo` destination should be popped from the back stack. | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/navigation/PopUpToBuilder#saveState()` Whether the back stack and the state of all destinations between the current destination and the `https://developer.android.com/reference/kotlin/androidx/navigation/NavOptionsBuilder#popUpTo(kotlin.String,kotlin.Function1)` ID should be saved for later restoration via `https://developer.android.com/reference/kotlin/androidx/navigation/NavOptionsBuilder#restoreState()` or the `restoreState` attribute using the same `https://developer.android.com/reference/kotlin/androidx/navigation/NavOptionsBuilder#popUpTo(kotlin.String,kotlin.Function1)` ID (note: this matching ID is true if `https://developer.android.com/reference/kotlin/androidx/navigation/PopUpToBuilder#inclusive()` is true. | Cmn |

## Public constructors

### PopUpToBuilder

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

```
PopUpToBuilder()
```

## Public properties

### inclusive

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

```
var inclusive: Boolean
```

Whether the `popUpTo` destination should be popped from the back stack.

### saveState

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

```
var saveState: Boolean
```

Whether the back stack and the state of all destinations between the current destination and the `https://developer.android.com/reference/kotlin/androidx/navigation/NavOptionsBuilder#popUpTo(kotlin.String,kotlin.Function1)` ID should be saved for later restoration via `https://developer.android.com/reference/kotlin/androidx/navigation/NavOptionsBuilder#restoreState()` or the `restoreState` attribute using the same `https://developer.android.com/reference/kotlin/androidx/navigation/NavOptionsBuilder#popUpTo(kotlin.String,kotlin.Function1)` ID (note: this matching ID is true if `https://developer.android.com/reference/kotlin/androidx/navigation/PopUpToBuilder#inclusive()` is true. If `https://developer.android.com/reference/kotlin/androidx/navigation/PopUpToBuilder#inclusive()` is false, this matching ID is the id of the last destination that is popped).