# ModalBottomSheetProperties

Artifact: [androidx.compose.material3:material3](https://developer.android.com/jetpack/androidx/releases/compose-material3) [View Source](https://cs.android.com/search?q=file:androidx/compose/material3/ModalBottomSheet.+class:androidx.compose.material3.ModalBottomSheetProperties) Common/AllAndroid/JVM
- Cmn

  ```
  @ExperimentalMaterial3Api
  class ModalBottomSheetProperties
  ```

*** ** * ** ***

Properties used to customize the behavior of a `https://developer.android.com/reference/kotlin/androidx/compose/material3/ModalBottomSheet.composable#ModalBottomSheet(kotlin.Function0,androidx.compose.ui.Modifier,androidx.compose.material3.SheetState,androidx.compose.ui.unit.Dp,kotlin.Boolean,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.unit.Dp,androidx.compose.ui.graphics.Color,kotlin.Function0,kotlin.Function0,androidx.compose.material3.ModalBottomSheetProperties,kotlin.Function1)`.

## Summary

| ### Public constructors |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/ModalBottomSheetProperties#ModalBottomSheetProperties()()` Properties used to customize the behavior of a `https://developer.android.com/reference/kotlin/androidx/compose/material3/ModalBottomSheet.composable#ModalBottomSheet(kotlin.Function0,androidx.compose.ui.Modifier,androidx.compose.material3.SheetState,androidx.compose.ui.unit.Dp,kotlin.Boolean,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.unit.Dp,androidx.compose.ui.graphics.Color,kotlin.Function0,kotlin.Function0,androidx.compose.material3.ModalBottomSheetProperties,kotlin.Function1)`. | android |
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/ModalBottomSheetProperties#ModalBottomSheetProperties(kotlin.Boolean,kotlin.Boolean)( shouldDismissOnBackPress: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, shouldDismissOnClickOutside: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html )` | Cmn android |
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/ModalBottomSheetProperties#ModalBottomSheetProperties(androidx.compose.ui.window.SecureFlagPolicy,kotlin.Boolean,kotlin.Boolean)( securePolicy: https://developer.android.com/reference/kotlin/androidx/compose/ui/window/SecureFlagPolicy, shouldDismissOnBackPress: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, shouldDismissOnClickOutside: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html )` Properties used to customize the behavior of a `https://developer.android.com/reference/kotlin/androidx/compose/material3/ModalBottomSheet.composable#ModalBottomSheet(kotlin.Function0,androidx.compose.ui.Modifier,androidx.compose.material3.SheetState,androidx.compose.ui.unit.Dp,kotlin.Boolean,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.unit.Dp,androidx.compose.ui.graphics.Color,kotlin.Function0,kotlin.Function0,androidx.compose.material3.ModalBottomSheetProperties,kotlin.Function1)`. | android |
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/ModalBottomSheetProperties#ModalBottomSheetProperties(kotlin.Boolean,kotlin.Boolean,androidx.compose.ui.window.SecureFlagPolicy,kotlin.Boolean,kotlin.Boolean)( isAppearanceLightStatusBars: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, isAppearanceLightNavigationBars: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, securePolicy: https://developer.android.com/reference/kotlin/androidx/compose/ui/window/SecureFlagPolicy, shouldDismissOnBackPress: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, shouldDismissOnClickOutside: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html )` Properties used to customize the behavior of a `https://developer.android.com/reference/kotlin/androidx/compose/material3/ModalBottomSheet.composable#ModalBottomSheet(kotlin.Function0,androidx.compose.ui.Modifier,androidx.compose.material3.SheetState,androidx.compose.ui.unit.Dp,kotlin.Boolean,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.unit.Dp,androidx.compose.ui.graphics.Color,kotlin.Function0,kotlin.Function0,androidx.compose.material3.ModalBottomSheetProperties,kotlin.Function1)`. | android |

| ### Public functions |
|---|---|---|
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ModalBottomSheetProperties#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` | android |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ModalBottomSheetProperties#hashCode()()` | android |

| ### Public properties |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/window/SecureFlagPolicy` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ModalBottomSheetProperties#securePolicy()` Policy for setting `https://developer.android.com/reference/android/view/WindowManager.LayoutParams.html#FLAG_SECURE` on the bottom sheet's window. | android |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ModalBottomSheetProperties#shouldDismissOnBackPress()` | Cmn android |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ModalBottomSheetProperties#shouldDismissOnClickOutside()` | Cmn android |

## Public constructors

### ModalBottomSheetProperties

android

```
ModalBottomSheetProperties()
```

Properties used to customize the behavior of a `https://developer.android.com/reference/kotlin/androidx/compose/material3/ModalBottomSheet.composable#ModalBottomSheet(kotlin.Function0,androidx.compose.ui.Modifier,androidx.compose.material3.SheetState,androidx.compose.ui.unit.Dp,kotlin.Boolean,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.unit.Dp,androidx.compose.ui.graphics.Color,kotlin.Function0,kotlin.Function0,androidx.compose.material3.ModalBottomSheetProperties,kotlin.Function1)`.

This constructor provides default behavior for `https://developer.android.com/reference/kotlin/androidx/compose/material3/ModalBottomSheet.composable#ModalBottomSheet(kotlin.Function0,androidx.compose.ui.Modifier,androidx.compose.material3.SheetState,androidx.compose.ui.unit.Dp,kotlin.Boolean,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.unit.Dp,androidx.compose.ui.graphics.Color,kotlin.Function0,kotlin.Function0,androidx.compose.material3.ModalBottomSheetProperties,kotlin.Function1)`. See other constructors for customization options.

### ModalBottomSheetProperties

Cmn android

```
ModalBottomSheetProperties(
    shouldDismissOnBackPress: Boolean = true,
    shouldDismissOnClickOutside: Boolean = true
)
```

| Parameters |
|---|---|
| `shouldDismissOnBackPress: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = true` | Whether the modal bottom sheet can be dismissed by pressing the back button. If true, pressing the back button will call onDismissRequest. |
| `shouldDismissOnClickOutside: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = true` | Whether the modal bottom sheet can be dismissed by clicking on the scrim. |

### ModalBottomSheetProperties

android

```
ModalBottomSheetProperties(
    securePolicy: SecureFlagPolicy = SecureFlagPolicy.Inherit,
    shouldDismissOnBackPress: Boolean = true,
    shouldDismissOnClickOutside: Boolean = true
)
```

Properties used to customize the behavior of a `https://developer.android.com/reference/kotlin/androidx/compose/material3/ModalBottomSheet.composable#ModalBottomSheet(kotlin.Function0,androidx.compose.ui.Modifier,androidx.compose.material3.SheetState,androidx.compose.ui.unit.Dp,kotlin.Boolean,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.unit.Dp,androidx.compose.ui.graphics.Color,kotlin.Function0,kotlin.Function0,androidx.compose.material3.ModalBottomSheetProperties,kotlin.Function1)`.

| Parameters |
|---|---|
| `securePolicy: https://developer.android.com/reference/kotlin/androidx/compose/ui/window/SecureFlagPolicy = SecureFlagPolicy.Inherit` | Policy for setting `https://developer.android.com/reference/android/view/WindowManager.LayoutParams.html#FLAG_SECURE` on the bottom sheet's window. |
| `shouldDismissOnBackPress: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = true` | Whether the modal bottom sheet can be dismissed by pressing the back button. If true, pressing the back button will call onDismissRequest. |
| `shouldDismissOnClickOutside: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = true` | Whether the modal bottom sheet can be dismissed by clicking on the scrim. |

### ModalBottomSheetProperties

android

```
ModalBottomSheetProperties(
    isAppearanceLightStatusBars: Boolean,
    isAppearanceLightNavigationBars: Boolean,
    securePolicy: SecureFlagPolicy = SecureFlagPolicy.Inherit,
    shouldDismissOnBackPress: Boolean = true,
    shouldDismissOnClickOutside: Boolean = true
)
```

Properties used to customize the behavior of a `https://developer.android.com/reference/kotlin/androidx/compose/material3/ModalBottomSheet.composable#ModalBottomSheet(kotlin.Function0,androidx.compose.ui.Modifier,androidx.compose.material3.SheetState,androidx.compose.ui.unit.Dp,kotlin.Boolean,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.unit.Dp,androidx.compose.ui.graphics.Color,kotlin.Function0,kotlin.Function0,androidx.compose.material3.ModalBottomSheetProperties,kotlin.Function1)`.

Use this constructor to customize the behavior of status and navigation bars on the `https://developer.android.com/reference/kotlin/androidx/compose/material3/ModalBottomSheet.composable#ModalBottomSheet(kotlin.Function0,androidx.compose.ui.Modifier,androidx.compose.material3.SheetState,androidx.compose.ui.unit.Dp,kotlin.Boolean,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.unit.Dp,androidx.compose.ui.graphics.Color,kotlin.Function0,kotlin.Function0,androidx.compose.material3.ModalBottomSheetProperties,kotlin.Function1)` window.

| Parameters |
|---|---|
| `isAppearanceLightStatusBars: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | If true, changes the foreground color of the status bars to light so that the items on the bar can be read clearly. If false, reverts to the default appearance. |
| `isAppearanceLightNavigationBars: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | If true, changes the foreground color of the navigation bars to light so that the items on the bar can be read clearly. If false, reverts to the default appearance. |
| `securePolicy: https://developer.android.com/reference/kotlin/androidx/compose/ui/window/SecureFlagPolicy = SecureFlagPolicy.Inherit` | Policy for setting `https://developer.android.com/reference/android/view/WindowManager.LayoutParams.html#FLAG_SECURE` on the bottom sheet's window. |
| `shouldDismissOnBackPress: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = true` | Whether the modal bottom sheet can be dismissed by pressing the back button. If true, pressing the back button will call onDismissRequest. |
| `shouldDismissOnClickOutside: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = true` | Whether the modal bottom sheet can be dismissed by clicking on the scrim. |

## Public functions

### equals

android

```
open operator fun equals(other: Any?): Boolean
```

### hashCode

android

```
open fun hashCode(): Int
```

## Public properties

### securePolicy

android

```
val securePolicy: SecureFlagPolicy
```

Policy for setting `https://developer.android.com/reference/android/view/WindowManager.LayoutParams.html#FLAG_SECURE` on the bottom sheet's window.

### shouldDismissOnBackPress

Cmn android

```
val shouldDismissOnBackPress: Boolean
```

### shouldDismissOnClickOutside

Cmn android

```
val shouldDismissOnClickOutside: Boolean
```