Package-level declarations

Types

Link copied to clipboard
external interface DoubleOrString

Union of a pixel count and a CSS length string, used by OverlayBounds.

Link copied to clipboard

Attribute names of <vaadin-overlay>, for use with setAttribute.

Link copied to clipboard
external interface OverlayBounds

The bounds an overlay is positioned at.

Link copied to clipboard

The bounds accepted by setBounds.

Link copied to clipboard

<vaadin-overlay> is a Web Component for creating overlays. The content of the overlay can be populated imperatively by using renderer callback function.

Link copied to clipboard

Typed event names of <vaadin-overlay>, for use with addEventHandler.

Link copied to clipboard
external interface OverlayFocusMixin
Link copied to clipboard
Link copied to clipboard
typealias OverlayRenderer = (HTMLElement, HTMLElement, JsAny?) -> Unit

Renders the content of an overlay.

Link copied to clipboard
external interface OverlayStackMixin
Link copied to clipboard
external interface PositionMixin
Link copied to clipboard
external interface StringOrBoolean

Union of:

Functions

Link copied to clipboard
fun createOverlay(configure: OverlayElement.() -> Unit = {}): OverlayElement

Creates a <vaadin-overlay> element. The custom element is registered on first use.

Link copied to clipboard

Wraps a pixel count as a DoubleOrString.

Wraps a CSS length as a DoubleOrString.

Link copied to clipboard
external fun getStateAnimations(element: HTMLElement): Array<Animation>

Collect the animations that report the state of the given element, so that their end can be awaited before the element is hidden or removed. The animations are read instead of the computed style, so that the decision to wait cannot disagree with what the browser actually created: a keyframes rule that does not exist and an element that is not rendered both give an empty list.

Link copied to clipboard
external fun observeMove(element: HTMLElement, callback: () -> Unit): () -> Unit

Observe moving an element around on a page.

Link copied to clipboard

Imports @vaadin/overlay/src/vaadin-overlay.js, registering <vaadin-overlay>, and returns the element class.

Link copied to clipboard
external fun setOverlayStateAttribute(overlay: HTMLElement, name: String, value: StringOrBoolean)

Toggle the state attribute on the overlay element and also its owner element. This allows targeting state attributes in the light DOM in case the overlay is in the shadow DOM of its owner.