MenuOverlayMixin

Properties

Link copied to clipboard
abstract var focusTrap: Boolean

Set to true to move focus into the overlay automatically on open and keep it inside: Tab and Shift+Tab cycle through the overlay's content until the overlay is closed.

Link copied to clipboard
abstract var horizontalAlign: String

When positionTarget is set, this property defines whether to align the overlay's left or right side to the target element by default. Possible values are start and end. RTL is taken into account when interpreting the value. The overlay is automatically flipped to the opposite side when it doesn't fit into the default side defined by this property.

Link copied to clipboard

When positionTarget is set, this property defines whether the overlay should overlap the target element in the x-axis, or be positioned right next to it.

Link copied to clipboard

When positionTarget is set, this property defines whether the overlay should overlap the target element in the y-axis, or be positioned right above/below it.

Link copied to clipboard
abstract var positionTarget: JsAny

The element next to which this overlay should be aligned. The position of the overlay relative to the positionTarget can be adjusted with properties horizontalAlign, verticalAlign, noHorizontalOverlap and noVerticalOverlap.

Link copied to clipboard

If the overlay content has no intrinsic height, this property can be used to set the minimum vertical space (in pixels) required by the overlay. Setting a value to the property effectively disables the content measurement in favor of using this fixed value for determining the open direction.

Link copied to clipboard
abstract var restoreFocusNode: HTMLElement

Set to specify the element which should be focused on overlay close, if restoreFocusOnClose is set to true.

Link copied to clipboard

Set to true to enable restoring of focus when overlay is closed.

Link copied to clipboard
abstract var verticalAlign: String

When positionTarget is set, this property defines whether to align the overlay's top or bottom side to the target element by default. Possible values are top and bottom. The overlay is automatically flipped to the opposite side when it doesn't fit into the default side defined by this property.

Functions

Link copied to clipboard
abstract fun getBoundaries(): JsAny

Returns the adjusted boundaries of the overlay.