ModalBottomSheetProperties


Properties used to customize the behavior of a ModalBottomSheet.

Summary

Public constructors

Properties used to customize the behavior of a ModalBottomSheet.

android
ModalBottomSheetProperties(
    shouldDismissOnBackPress: Boolean,
    shouldDismissOnClickOutside: Boolean
)
Cmn
android
ModalBottomSheetProperties(
    securePolicy: SecureFlagPolicy,
    shouldDismissOnBackPress: Boolean,
    shouldDismissOnClickOutside: Boolean
)

Properties used to customize the behavior of a ModalBottomSheet.

android
ModalBottomSheetProperties(
    isAppearanceLightStatusBars: Boolean,
    isAppearanceLightNavigationBars: Boolean,
    securePolicy: SecureFlagPolicy,
    shouldDismissOnBackPress: Boolean,
    shouldDismissOnClickOutside: Boolean
)

Properties used to customize the behavior of a ModalBottomSheet.

android

Public functions

open operator Boolean
equals(other: Any?)
android
open Int
android

Public constructors

ModalBottomSheetProperties

ModalBottomSheetProperties()

Properties used to customize the behavior of a ModalBottomSheet.

This constructor provides default behavior for ModalBottomSheet. See other constructors for customization options.

ModalBottomSheetProperties

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

Whether the modal bottom sheet can be dismissed by pressing the back button. If true, pressing the back button will call onDismissRequest.

shouldDismissOnClickOutside: Boolean = true

Whether the modal bottom sheet can be dismissed by clicking on the scrim.

ModalBottomSheetProperties

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

Properties used to customize the behavior of a ModalBottomSheet.

Parameters
securePolicy: SecureFlagPolicy = SecureFlagPolicy.Inherit

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

shouldDismissOnBackPress: Boolean = true

Whether the modal bottom sheet can be dismissed by pressing the back button. If true, pressing the back button will call onDismissRequest.

shouldDismissOnClickOutside: Boolean = true

Whether the modal bottom sheet can be dismissed by clicking on the scrim.

ModalBottomSheetProperties

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

Properties used to customize the behavior of a ModalBottomSheet.

Use this constructor to customize the behavior of status and navigation bars on the ModalBottomSheet window.

Parameters
isAppearanceLightStatusBars: Boolean

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: Boolean

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: SecureFlagPolicy = SecureFlagPolicy.Inherit

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

shouldDismissOnBackPress: Boolean = true

Whether the modal bottom sheet can be dismissed by pressing the back button. If true, pressing the back button will call onDismissRequest.

shouldDismissOnClickOutside: Boolean = true

Whether the modal bottom sheet can be dismissed by clicking on the scrim.

Public functions

equals

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

hashCode

open fun hashCode(): Int

Public properties

securePolicy

val securePolicySecureFlagPolicy

shouldDismissOnBackPress

val shouldDismissOnBackPressBoolean

shouldDismissOnClickOutside

val shouldDismissOnClickOutsideBoolean