SpatialPopupProperties

class SpatialPopupProperties

SpatialPopup properties.

Summary

Public constructors
SpatialPopupProperties(
    focusable: Boolean,
    dismissOnBackPress: Boolean,
    dismissOnClickOutside: Boolean,
    clippingEnabled: Boolean,
    spatialElevationLevel: SpatialElevationLevel
)

Public functions
SpatialPopupProperties
copy(
    focusable: Boolean,
    dismissOnBackPress: Boolean,
    dismissOnClickOutside: Boolean,
    clippingEnabled: Boolean,
    spatialElevationLevel: SpatialElevationLevel
)
open operator Boolean
equals(other: Any?)
open Int
open String

Public properties
Boolean

whether to allow the popup window to extend beyond the screen boundaries.
Boolean

whether the popup can be dismissed by pressing the back button (Android) or escape key (desktop).
Boolean

whether the popup can be dismissed by clicking outside its bounds.
Boolean

whether the popup is focusable.
SpatialElevationLevel

the resting level of the elevated popup.

Public constructors

SpatialPopupProperties

SpatialPopupProperties(
    focusable: Boolean = false,
    dismissOnBackPress: Boolean = true,
    dismissOnClickOutside: Boolean = true,
    clippingEnabled: Boolean = true,
    spatialElevationLevel: SpatialElevationLevel = SpatialElevationLevel.Level3
)

Public functions

copy

fun copy(
    focusable: Boolean = this.focusable,
    dismissOnBackPress: Boolean = this.dismissOnBackPress,
    dismissOnClickOutside: Boolean = this.dismissOnClickOutside,
    clippingEnabled: Boolean = this.clippingEnabled,
    spatialElevationLevel: SpatialElevationLevel = this.spatialElevationLevel
): SpatialPopupProperties

equals

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

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

clippingEnabled

Added in 1.0.0-alpha01
val clippingEnabled: Boolean

whether to allow the popup window to extend beyond the screen boundaries. Defaults to true. Setting this to false will allow windows to be accurately positioned.

dismissOnBackPress

Added in 1.0.0-alpha01
val dismissOnBackPress: Boolean

whether the popup can be dismissed by pressing the back button (Android) or escape key (desktop). Only effective if focusable is true. Defaults to true.

dismissOnClickOutside

Added in 1.0.0-alpha01
val dismissOnClickOutside: Boolean

whether the popup can be dismissed by clicking outside its bounds. If true, clicking outside the popup will call onDismissRequest. Defaults to true.

focusable

Added in 1.0.0-alpha01
val focusable: Boolean

whether the popup is focusable. If true, it will handle IME events and key presses (e.g., back button). Defaults to false.

spatialElevationLevel

Added in 1.0.0-alpha01
val spatialElevationLevel: SpatialElevationLevel

the resting level of the elevated popup. Defaults to SpatialElevationLevel.Level3.