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

When set to true, the overlay is hidden. This also closes the overlay immediately in case there is a closing animation in progress.

Link copied to clipboard
abstract var model: JsAny

Object with properties that is passed to renderer function

Link copied to clipboard
abstract var modeless: Boolean

When true the overlay won't disable the main content, showing it doesn't change the functionality of the user interface.

Link copied to clipboard
abstract var opened: Boolean

When true, the overlay is visible and attached to body.

Link copied to clipboard
abstract var owner: HTMLElement

Owner element passed with renderer function

Link copied to clipboard
abstract var renderer: OverlayRenderer?

Custom function for rendering the content of the overlay. Receives three arguments:

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

When true the overlay has backdrop on top of content when opened.

Functions

Link copied to clipboard
abstract fun bringToFront()

Brings the overlay as visually the frontmost one.

Link copied to clipboard
abstract fun close(sourceEvent: Event)
Link copied to clipboard
abstract fun requestContentUpdate()

Requests an update for the content of the overlay. While performing the update, it invokes the renderer passed in the renderer property.

Link copied to clipboard
abstract fun setBounds(bounds: OverlayBoundsParam, absolute: Boolean = definedExternally)

Updates the coordinates of the overlay.