ModalBottomSheetProperties

Artifact: androidx.compose.material3:material3

Added in 1.2.0

Kotlin |Java

android

@ExperimentalMaterial3Api
class ModalBottomSheetProperties

Properties used to customize the behavior of a ModalBottomSheet.

Summary

Public constructors
`ModalBottomSheetProperties( securePolicy: SecureFlagPolicy, isFocusable: Boolean, shouldDismissOnBackPress: Boolean )`	android

Public functions
`open operator Boolean`	`equals(other: Any?)`	android
`open Int`	`hashCode()`	android

Public properties
`Boolean`	`isFocusable` Whether the modal bottom sheet is focusable.	android
`SecureFlagPolicy`	`securePolicy` Policy for setting `WindowManager.LayoutParams.FLAG_SECURE` on the bottom sheet's window.	android
`Boolean`	`shouldDismissOnBackPress` Whether the modal bottom sheet can be dismissed by pressing the back button.	android

Public constructors

ModalBottomSheetProperties

android

Added in 1.2.0

ModalBottomSheetProperties(
    securePolicy: SecureFlagPolicy,
    isFocusable: Boolean,
    shouldDismissOnBackPress: Boolean
)

Parameters
`securePolicy: SecureFlagPolicy`	Policy for setting `WindowManager.LayoutParams.FLAG_SECURE` on the bottom sheet's window.
`isFocusable: Boolean`	Whether the modal bottom sheet is focusable. When true, the modal bottom sheet will receive IME events and key presses, such as when the back button is pressed.
`shouldDismissOnBackPress: Boolean`	Whether the modal bottom sheet can be dismissed by pressing the back button. If true, pressing the back button will call onDismissRequest. Note that `isFocusable` must be set to true in order to receive key events such as the back button - if the modal bottom sheet is not focusable then this property does nothing.

Public functions

equals

android

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

hashCode

android

open fun hashCode(): Int

Public properties

isFocusable

android

Added in 1.2.0

val isFocusable: Boolean

Whether the modal bottom sheet is focusable. When true, the modal bottom sheet will receive IME events and key presses, such as when the back button is pressed.

securePolicy

android

Added in 1.2.0

val securePolicy: SecureFlagPolicy

Policy for setting WindowManager.LayoutParams.FLAG_SECURE on the bottom sheet's window.

shouldDismissOnBackPress

android

Added in 1.2.0

val shouldDismissOnBackPress: Boolean

Whether the modal bottom sheet can be dismissed by pressing the back button. If true, pressing the back button will call onDismissRequest. Note that isFocusable must be set to true in order to receive key events such as the back button - if the modal bottom sheet is not focusable then this property does nothing.