Package-level declarations

Types

Link copied to clipboard

Attribute names of <vaadin-master-detail-layout>, for use with setAttribute.

Link copied to clipboard
abstract external class MasterDetailLayoutElement : HTMLElement, ElementMixin, ThemableMixin, PolylitMixin

<vaadin-master-detail-layout> is a web component for building UIs with a master (or primary) area and a detail (or secondary) area that is displayed next to, or overlaid on top of, the master area, depending on configuration and viewport size.

Link copied to clipboard

Typed event names of <vaadin-master-detail-layout>, for use with addEventHandler.

Functions

Link copied to clipboard
external fun animateIn(element: HTMLElement, effects: Array<String>, progress: Double): Promise<Unit>

Runs an enter animation on the element.

Link copied to clipboard
external fun animateOut(element: HTMLElement, effects: Array<String>, progress: Double): Promise<Unit>

Runs an exit animation on the element.

Link copied to clipboard
external fun cancelAnimations(element: HTMLElement)

Cancels all running animations on the element that match the shared animation ID.

Link copied to clipboard

Creates a <vaadin-master-detail-layout> element. The custom element is registered on first use.

Link copied to clipboard
external fun detectOverflow(hostSize: Double, trackSizes: Array<Double>): Boolean

Determines whether the detail area overflows the host element, meaning it should be shown as an overlay instead of side-by-side.

Link copied to clipboard
external fun getCurrentAnimation(element: HTMLElement): Animation?

Returns the currently running master-detail-layout animation on the element, if any. Matches by the shared animation ID and 'running' play state.

Link copied to clipboard
external fun getCurrentAnimationProgress(element: HTMLElement): Double

Returns the overall progress (0–1) of the current animation on the element, computed as currentTime / duration. Returns 0 when no animation is running.

Link copied to clipboard
external fun parseTrackSizes(gridTemplate: String): Array<Double>

Parses a computed gridTemplateColumns / gridTemplateRows value into an array of track sizes in pixels. Line names (e.g. [name]) are stripped before parsing.

Link copied to clipboard

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