Class

ModalWideNavigationRailProperties

Properties used to customize the behavior of a ModalWideNavigationRail.

Source set: Common

Added in 1.5.0-alpha17

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

shouldDismissOnBackPress

Source set: Common

Added in 1.5.0-alpha17

val shouldDismissOnBackPress: Boolean
Source set: Android

Added in 1.5.0-alpha17

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

Added in 1.5.0-alpha17

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