---
title: "ModalWideNavigationRailProperties"
description: "Properties used to customize the behavior of a [ModalWideNavigationRail]."
type: "class"
---

<div class='type'>Class</div>


<a id='references'></a>

<div class='sourceset sourceset-common'>Common</div>


```kotlin
expect class ModalWideNavigationRailProperties(shouldDismissOnBackPress: Boolean = true)
```


Properties used to customize the behavior of a `ModalWideNavigationRail`.

#### Parameters

| | |
| --- | --- |
| shouldDismissOnBackPress | Whether the modal navigation rail can be dismissed by pressing the back button. If true, pressing the back button will call onDismissRequest. |



## Properties

<div class='sourceset sourceset-common'>Common</div>


```kotlin
val shouldDismissOnBackPress: Boolean
```


<div class='sourceset sourceset-android'>Android</div>


```kotlin
actual class ModalWideNavigationRailProperties(
    val securePolicy: SecureFlagPolicy = SecureFlagPolicy.Inherit,
    @get:Suppress("GetterSetterNames") actual val shouldDismissOnBackPress: Boolean = true,
)
```


Properties used to customize the behavior of a `ModalWideNavigationRail`.

#### Parameters

| | |
| --- | --- |
| securePolicy | Policy for setting `WindowManager.LayoutParams.FLAG_SECURE` on the modal navigation rail's window. |
| shouldDismissOnBackPress | Whether the modal navigation rail can be dismissed by pressing the back button. If true, pressing the back button will call onDismissRequest. |



## Secondary Constructors

```kotlin
actual constructor(
    shouldDismissOnBackPress: Boolean
) : this(
    securePolicy = SecureFlagPolicy.Inherit,
    shouldDismissOnBackPress = shouldDismissOnBackPress,
)
```