PopupOverlaySpec

class PopupOverlaySpec(val anchorId: String, val alignment: PopupAlignment = PopupAlignment.BelowStart, val overflowPolicy: PopupOverflowPolicy = PopupOverflowPolicy.FlipThenClamp, val windowMargin: Int = 0, val dismissOnClickOutside: Boolean = true, val focusable: Boolean = true, val offsetX: Int = 0, val offsetY: Int = 0, val onDismissRequest: () -> Unit? = null)(source)

Describes platform-neutral placement, dismissal, and focus behavior for one popup.

Callback identity does not participate in equality. Recomposition therefore updates a platform popup only when placement or interaction policy changes.

Constructors

Link copied to clipboard
constructor(anchorId: String, alignment: PopupAlignment = PopupAlignment.BelowStart, overflowPolicy: PopupOverflowPolicy = PopupOverflowPolicy.FlipThenClamp, windowMargin: Int = 0, dismissOnClickOutside: Boolean = true, focusable: Boolean = true, offsetX: Int = 0, offsetY: Int = 0, onDismissRequest: () -> Unit? = null)

Properties

Link copied to clipboard

preferred placement relative to the anchor

Link copied to clipboard

platform identifier of the view used as the placement anchor

Link copied to clipboard

whether an outside pointer event requests dismissal

Link copied to clipboard

whether the popup may receive input focus

Link copied to clipboard

horizontal offset in host coordinate units

Link copied to clipboard

vertical offset in host coordinate units

Link copied to clipboard

invoked when the platform requests dismissal; the owner must remove the declaration

Link copied to clipboard

correction applied when the popup exceeds the viewport

Link copied to clipboard

minimum requested distance from viewport edges, in host coordinate units

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean

Compares placement and interaction policy while intentionally ignoring callback identity.

Link copied to clipboard
open override fun hashCode(): Int

Returns a hash of the placement and interaction policy.