ContextMenuElement

<vaadin-context-menu> is a Web Component for creating context menus.

Items

Items is a higher level convenience API for defining a (hierarchical) menu structure for the component. If a menu item has a non-empty children set, a sub-menu with the child items is opened next to the parent menu on mouseover, tap or a right arrow keypress.

When an item is selected, <vaadin-context-menu> dispatches an "item-selected" event with the selected item as event.detail.value property. If item does not have keepOpen property the menu will be closed.

contextMenu.items = [
{ text: 'Menu Item 1', theme: 'primary', className: 'first', children:
[
{ text: 'Menu Item 1-1', checked: true, keepOpen: true },
{ text: 'Menu Item 1-2' }
]
},
{ component: 'hr' },
{ text: 'Menu Item 2', children:
[
{ text: 'Menu Item 2-1' },
{ text: 'Menu Item 2-2', disabled: true }
]
},
{ text: 'Menu Item 3', disabled: true, className: 'last' }
];

contextMenu.addEventListener('item-selected', e => {
const item = e.detail.value;
console.log(`${item.text} selected`);
});

NOTE: when the items array is defined, the renderer cannot be used.

Disabled menu items

When disabled, menu items are rendered as "dimmed".

By default, disabled items are not focusable and don't react to hover. As a result, they are hidden from assistive technologies, and it's not possible to show a tooltip to explain why they are disabled. This can be addressed by enabling the feature flag accessibleDisabledMenuItems, which makes disabled items focusable and hoverable, while still preventing them from being activated:

// Set before any context menu is attached to the DOM.
window.Vaadin.featureFlags.accessibleDisabledMenuItems = true;

Item tooltips

Menu items can have tooltips that are shown on hover and keyboard focus. To enable them, add a slotted <vaadin-tooltip> element and set the tooltip property on each item that should have one:

<vaadin-context-menu>
<vaadin-tooltip slot="tooltip"></vaadin-tooltip>
</vaadin-context-menu>

Slotted list-box

The content of the menu can also be populated by providing a custom <vaadin-context-menu-list-box> with the overlay slot:

<vaadin-context-menu>
<vaadin-context-menu-list-box slot="overlay">
<vaadin-context-menu-item>Edit</vaadin-context-menu-item>
<vaadin-context-menu-item>Delete</vaadin-context-menu-item>
</vaadin-context-menu-list-box>
</vaadin-context-menu>

Note: slotted list-box supports a single root-level menu only and cannot be combined with the items or renderer API.

Rendering

The content of the menu can be populated by using the renderer callback function.

The renderer function provides root, contextMenu, model arguments when applicable. Generate DOM content by using model object properties if needed, append it to the root element and control the state of the host element by accessing contextMenu. Before generating new content, the renderer function should check if there is already content in root for reusing it.

<vaadin-context-menu id="contextMenu">
<p>This paragraph has a context menu.</p>
</vaadin-context-menu>
const contextMenu = document.querySelector('#contextMenu');
contextMenu.renderer = (root, contextMenu, context) => {
let listBox = root.firstElementChild;
if (!listBox) {
listBox = document.createElement('vaadin-list-box');
root.appendChild(listBox);
}

let item = listBox.querySelector('vaadin-item');
if (!item) {
item = document.createElement('vaadin-item');
listBox.appendChild(item);
}
item.textContent = 'Content of the selector: ' + context.target.textContent;
};

You can access the menu context inside the renderer using context.target and context.detail.

Renderer is called on the opening of the context-menu and each time the related context is updated. DOM generated during the renderer call can be reused in the next renderer call and will be provided with the root argument. On first call it will be empty.

vaadin-contextmenu Gesture Event

vaadin-contextmenu is a gesture event (a custom event), which is dispatched after either contextmenu or long touch events. This enables support for both mouse and touch environments in a uniform way.

<vaadin-context-menu> opens the menu overlay on the vaadin-contextmenu event by default.

Menu Listener

By default, the <vaadin-context-menu> element listens for the menu opening event on itself. In case if you do not want to wrap the target, you can listen for events on an element outside the <vaadin-context-menu> by setting the listenOn property:

<vaadin-context-menu id="contextMenu"></vaadin-context-menu>

<div id="menuListener">The element that listens for the contextmenu event.</div>
const contextMenu = document.querySelector('#contextMenu');
contextMenu.listenOn = document.querySelector('#menuListener');

Filtering Menu Targets

By default, the listener element and all its descendants open the context menu. You can filter the menu targets to a smaller set of elements inside the listener element by setting the selector property.

In the following example, only the elements matching .has-menu will open the context menu:

<vaadin-context-menu selector=".has-menu">
<p class="has-menu">This paragraph opens the context menu</p>
<p>This paragraph does not open the context menu</p>
</vaadin-context-menu>

Menu Context

The following properties are available in the context argument:

  • target is the menu opening event target, which is the element that the user has called the context menu for

  • detail is the menu opening event detail

In the following example, the menu item text is composed with the contents of the element that opened the menu:

<vaadin-context-menu selector="li" id="contextMenu">
<ul>
<li>Foo</li>
<li>Bar</li>
<li>Baz</li>
</ul>
</vaadin-context-menu>
const contextMenu = document.querySelector('#contextMenu');
contextMenu.renderer = (root, contextMenu, context) => {
let listBox = root.firstElementChild;
if (!listBox) {
listBox = document.createElement('vaadin-list-box');
root.appendChild(listBox);
}

let item = listBox.querySelector('vaadin-item');
if (!item) {
item = document.createElement('vaadin-item');
listBox.appendChild(item);
}
item.textContent = 'The menu target: ' + context.target.textContent;
};

Styling

The following shadow DOM parts are available for styling:

Part nameDescription
backdropBackdrop of the overlay
overlayThe overlay container
contentThe overlay content

Custom CSS Properties

The following custom CSS properties are available for styling:

Custom CSS propertyDescription
--vaadin-context-menu-offset-topUsed as an offset when using position and the context menu is aligned vertically below the target
--vaadin-context-menu-offset-bottomUsed as an offset when using position and the context menu is aligned vertically above the target
--vaadin-context-menu-offset-startUsed as an offset when using position and the context menu is aligned horizontally after the target
--vaadin-context-menu-offset-endUsed as an offset when using position and the context menu is aligned horizontally before the target

See Styling Components documentation.

Related components

In addition to <vaadin-context-menu> itself, the following components are themable:

  • #/elements/vaadin-context-menu-item - an item element.

  • #/elements/vaadin-context-menu-list-box - a list-box element.

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open var ariaActiveDescendantElement: Element?
Link copied to clipboard
open var ariaAtomic: String?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open var ariaBusy: String?
Link copied to clipboard
open var ariaChecked: String?
Link copied to clipboard
open var ariaColCount: String?
Link copied to clipboard
open var ariaColIndex: String?
Link copied to clipboard
Link copied to clipboard
open var ariaColSpan: String?
Link copied to clipboard
open var ariaControlsElements: ReadonlyArray<Element>?
Link copied to clipboard
open var ariaCurrent: String?
Link copied to clipboard
open var ariaDescribedByElements: ReadonlyArray<Element>?
Link copied to clipboard
Link copied to clipboard
open var ariaDetailsElements: ReadonlyArray<Element>?
Link copied to clipboard
open var ariaDisabled: String?
Link copied to clipboard
open var ariaErrorMessageElements: ReadonlyArray<Element>?
Link copied to clipboard
open var ariaExpanded: String?
Link copied to clipboard
open var ariaFlowToElements: ReadonlyArray<Element>?
Link copied to clipboard
open var ariaHasPopup: String?
Link copied to clipboard
open var ariaHidden: String?
Link copied to clipboard
open var ariaInvalid: String?
Link copied to clipboard
Link copied to clipboard
open var ariaLabel: String?
Link copied to clipboard
open var ariaLabelledByElements: ReadonlyArray<Element>?
Link copied to clipboard
open var ariaLevel: String?
Link copied to clipboard
open var ariaLive: String?
Link copied to clipboard
open var ariaModal: String?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open var ariaOwnsElements: ReadonlyArray<Element>?
Link copied to clipboard
Link copied to clipboard
open var ariaPosInSet: String?
Link copied to clipboard
open var ariaPressed: String?
Link copied to clipboard
open var ariaReadOnly: String?
Link copied to clipboard
open var ariaRelevant: String?
Link copied to clipboard
open var ariaRequired: String?
Link copied to clipboard
Link copied to clipboard
open var ariaRowCount: String?
Link copied to clipboard
open var ariaRowIndex: String?
Link copied to clipboard
Link copied to clipboard
open var ariaRowSpan: String?
Link copied to clipboard
open var ariaSelected: String?
Link copied to clipboard
open var ariaSetSize: String?
Link copied to clipboard
open var ariaSort: String?
Link copied to clipboard
open var ariaValueMax: String?
Link copied to clipboard
open var ariaValueMin: String?
Link copied to clipboard
open var ariaValueNow: String?
Link copied to clipboard
Link copied to clipboard
open val assignedSlot: HTMLSlotElement?
Link copied to clipboard
val attributes: NamedNodeMap
Link copied to clipboard
open val attributeStyleMap: StylePropertyMap
Link copied to clipboard
var autocapitalize: AutoCapitalize
Link copied to clipboard
Link copied to clipboard
open var autofocus: Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val childNodes: NodeList<ChildNode>
Link copied to clipboard
open val children: HTMLCollection<*>
Link copied to clipboard
val classList: DOMTokenList<ClassName>
Link copied to clipboard
var className: ClassName
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
abstract var closeOn: String

Event name to listen for closing the context menu.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val customElementRegistry: CustomElementRegistry?
Link copied to clipboard
open val dataset: DOMStringMap
Link copied to clipboard
var dataTestId: DataTestId?
Link copied to clipboard
var dir: String
Link copied to clipboard
Link copied to clipboard
var editContext: EditContext?
Link copied to clipboard
open var enterKeyHint: EnterKeyHint
Link copied to clipboard
val firstChild: ChildNode?
Link copied to clipboard
open val firstElementChild: Element?
Link copied to clipboard
var hidden: Hidden
Link copied to clipboard
var id: ElementId
Link copied to clipboard
Link copied to clipboard
var innerHTML: HtmlSource
Link copied to clipboard
Link copied to clipboard
open var inputMode: InputMode
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Defines a (hierarchical) menu structure for the component. If a menu item has a non-empty children set, a sub-menu with the child items is opened next to the parent menu on mouseover, tap or a right arrow keypress.

Link copied to clipboard
Link copied to clipboard
val lastChild: ChildNode?
Link copied to clipboard
open val lastElementChild: Element?
Link copied to clipboard
abstract var listenOn: HTMLElement

The target element that's listened to for context menu opening events. By default the vaadin-context-menu listens to the target's vaadin-contextmenu events.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open val nextElementSibling: Element?
Link copied to clipboard
val nextSibling: ChildNode?
Link copied to clipboard
Link copied to clipboard
val nodeType: NodeType
Link copied to clipboard
Link copied to clipboard
open var nonce: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val offsetParent: Element?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open var onabort: EventHandler<UIEvent, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onanimationcancel: EventHandler<AnimationEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onanimationend: EventHandler<AnimationEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onanimationiteration: EventHandler<AnimationEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onanimationstart: EventHandler<AnimationEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onauxclick: EventHandler<PointerEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onbeforeinput: EventHandler<InputEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onbeforematch: EventHandler<Event, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onbeforetoggle: EventHandler<ToggleEvent, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onblur: EventHandler<FocusEvent, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var oncancel: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var oncanplay: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var oncanplaythrough: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onchange: EventHandler<Event, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onclick: EventHandler<PointerEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onclose: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var oncommand: EventHandler<CommandEvent, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var oncontextlost: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var oncontextmenu: EventHandler<PointerEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var oncontextrestored: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var oncopy: EventHandler<ClipboardEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var oncuechange: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var oncut: EventHandler<ClipboardEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ondblclick: EventHandler<MouseEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ondrag: EventHandler<DragEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ondragend: EventHandler<DragEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ondragenter: EventHandler<DragEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ondragleave: EventHandler<DragEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ondragover: EventHandler<DragEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ondragstart: EventHandler<DragEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ondrop: EventHandler<DragEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ondurationchange: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onemptied: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onended: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onerror: JsFunction<*, *>?
Link copied to clipboard
open var onfocus: EventHandler<FocusEvent, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onformdata: EventHandler<FormDataEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
var onfullscreenchange: EventHandler<Event, Element, Node>?
Link copied to clipboard
var onfullscreenerror: EventHandler<Event, Element, Node>?
Link copied to clipboard
open var ongotpointercapture: EventHandler<PointerEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var oninput: EventHandler<InputEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var oninvalid: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onkeydown: EventHandler<KeyboardEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onkeyup: EventHandler<KeyboardEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onload: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onloadeddata: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onloadedmetadata: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onloadstart: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onlostpointercapture: EventHandler<PointerEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onmousedown: EventHandler<MouseEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onmouseenter: EventHandler<MouseEvent, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onmouseleave: EventHandler<MouseEvent, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onmousemove: EventHandler<MouseEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onmouseout: EventHandler<MouseEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onmouseover: EventHandler<MouseEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onmouseup: EventHandler<MouseEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onpaste: EventHandler<ClipboardEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onpause: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onplay: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onplaying: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onpointercancel: EventHandler<PointerEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onpointerdown: EventHandler<PointerEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onpointerenter: EventHandler<PointerEvent, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onpointerleave: EventHandler<PointerEvent, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onpointermove: EventHandler<PointerEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onpointerout: EventHandler<PointerEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onpointerover: EventHandler<PointerEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onpointerrawupdate: EventHandler<Event, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onpointerup: EventHandler<PointerEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onprogress: EventHandler<ProgressEvent, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onratechange: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onreset: EventHandler<Event, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onresize: EventHandler<UIEvent, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onscroll: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onscrollend: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onsecuritypolicyviolation: EventHandler<SecurityPolicyViolationEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onseeked: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onseeking: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onselect: EventHandler<Event, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onselectionchange: EventHandler<Event, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onselectstart: EventHandler<Event, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onslotchange: EventHandler<Event, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onstalled: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onsubmit: EventHandler<SubmitEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onsuspend: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var ontimeupdate: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var ontoggle: EventHandler<ToggleEvent, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var ontouchcancel: EventHandler<TouchEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ontouchend: EventHandler<TouchEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ontouchmove: EventHandler<TouchEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ontouchstart: EventHandler<TouchEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ontransitioncancel: EventHandler<TransitionEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ontransitionend: EventHandler<TransitionEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ontransitionrun: EventHandler<TransitionEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var ontransitionstart: EventHandler<TransitionEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
open var onvolumechange: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onwaiting: EventHandler<Event, GlobalEventHandlers, GlobalEventHandlers>?
Link copied to clipboard
open var onwheel: EventHandler<WheelEvent, GlobalEventHandlers, Node>?
Link copied to clipboard
abstract val opened: Boolean

True if the overlay is currently displayed.

Link copied to clipboard
abstract var openOn: String

Event name to listen for opening the context menu.

Link copied to clipboard
var outerHTML: HtmlSource
Link copied to clipboard
Link copied to clipboard
open override val ownerDocument: Document
Link copied to clipboard
val parentElement: HTMLElement?
Link copied to clipboard
val parentNode: ParentNode?
Link copied to clipboard
val part: DOMTokenList<JsString>
Link copied to clipboard
var popover: Popover?
Link copied to clipboard

Position of the overlay with respect to the target. Supported values: null, top-start, top, top-end, bottom-start, bottom, bottom-end, start-top, start, start-bottom, end-top, end, end-bottom.

Link copied to clipboard
Link copied to clipboard
open val previousElementSibling: Element?
Link copied to clipboard
val previousSibling: ChildNode?
Link copied to clipboard

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

Link copied to clipboard
open var role: String?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
abstract var selector: String

CSS selector that can be used to target any child element of the context menu to listen for openOn events.

Link copied to clipboard
val shadowRoot: ShadowRoot?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open val style: CSSStyleDeclaration
Link copied to clipboard
open var tabIndex: Int
Link copied to clipboard
Link copied to clipboard
open override var textContent: String?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
open fun after(vararg nodes: String)
open fun after(vararg nodes: Node)
Link copied to clipboard
open fun animate(keyframes: ReadonlyArray<Keyframe>?, options: Double): Animation
open fun animate(keyframes: ReadonlyArray<Keyframe>?, options: KeyframeAnimationOptions): Animation
open fun animate(keyframes: PropertyIndexedKeyframes?, options: Double): Animation
open fun animate(keyframes: PropertyIndexedKeyframes?, options: KeyframeAnimationOptions): Animation
Link copied to clipboard
open fun append(vararg nodes: String)
open fun append(vararg nodes: Node)
Link copied to clipboard
fun <T : Node> appendChild(node: T): T
Link copied to clipboard
fun attachInternals(): ElementInternals
Link copied to clipboard
fun attachShadow(init: ShadowRootInit): ShadowRoot
Link copied to clipboard
open fun before(vararg nodes: String)
open fun before(vararg nodes: Node)
Link copied to clipboard
open fun blur()
Link copied to clipboard
fun checkVisibility(options: CheckVisibilityOptions): Boolean
Link copied to clipboard
fun click()
Link copied to clipboard
fun cloneNode(subtree: Boolean): Node
Link copied to clipboard
abstract fun close()
Link copied to clipboard
fun closest(selector: String): Element?
fun <T : Element> closest(selector: TagName<T>): T?
Link copied to clipboard
fun compareDocumentPosition(other: Node): NodePosition
Link copied to clipboard
fun computedStyleMap(): StylePropertyMapReadOnly
Link copied to clipboard
fun contains(other: Node?): Boolean
Link copied to clipboard
open fun dispatchEvent(event: Event): Boolean
Link copied to clipboard
open fun focus(options: FocusOptions)
Link copied to clipboard
open fun getAnimations(options: GetAnimationsOptions): ReadonlyArray<Animation>
Link copied to clipboard
fun getAttribute(qualifiedName: String): String?
Link copied to clipboard
fun getAttributeNames(): ReadonlyArray<JsString>
Link copied to clipboard
fun getAttributeNode(qualifiedName: String): Attr?
Link copied to clipboard
fun getAttributeNodeNS(namespace: String?, localName: String): Attr?
Link copied to clipboard
fun getAttributeNS(namespace: String?, localName: String): String?
Link copied to clipboard
fun getBoundingClientRect(): DOMRect
Link copied to clipboard
fun getClientRects(): DOMRectList
Link copied to clipboard
fun getElementsByClassName(classNames: ClassName): HTMLCollection<Element>
Link copied to clipboard
fun getElementsByTagName(qualifiedName: String): HTMLCollection<Element>
fun <T : Element> getElementsByTagName(qualifiedName: TagName<T>): HTMLCollection<T>
Link copied to clipboard
fun getElementsByTagNameNS(namespace: String?, localName: String): HTMLCollection<Element>
fun <T : Element> getElementsByTagNameNS(namespaceURI: TagNamespace<T>, localName: TagName<T>): HTMLCollection<T>
Link copied to clipboard
fun getHTML(options: GetHTMLOptions): String
Link copied to clipboard
fun getRootNode(options: GetRootNodeOptions): Node
Link copied to clipboard
fun hasAttribute(qualifiedName: String): Boolean
Link copied to clipboard
fun hasAttributeNS(namespace: String?, localName: String): Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun hasPointerCapture(pointerId: Int): Boolean
Link copied to clipboard
Link copied to clipboard
fun insertAdjacentElement(where: InsertPosition, element: Element): Element?
Link copied to clipboard
fun insertAdjacentHTML(position: InsertPosition, string: String)
fun insertAdjacentHTML(position: InsertPosition, string: TrustedHTML)
Link copied to clipboard
fun insertAdjacentText(where: InsertPosition, data: String)
Link copied to clipboard
fun <T : Node> insertBefore(node: T, child: Node?): T
Link copied to clipboard
Link copied to clipboard
fun isEqualNode(otherNode: Node?): Boolean
Link copied to clipboard
fun isSameNode(otherNode: Node?): Boolean
Link copied to clipboard
Link copied to clipboard
fun lookupPrefix(namespace: String?): String?
Link copied to clipboard
fun matches(selectors: String): Boolean
Link copied to clipboard
open fun moveBefore(node: Node, child: Node?)
Link copied to clipboard
fun normalize()
Link copied to clipboard
abstract fun open(e: Event?)

Opens the overlay.

Link copied to clipboard
open fun prepend(vararg nodes: String)
open fun prepend(vararg nodes: Node)
Link copied to clipboard
open fun querySelector(selectors: String): Element?
open fun <T : Element> querySelector(selectors: TagName<T>): T?
Link copied to clipboard
open fun querySelectorAll(selectors: String): NodeList<Element>
open fun <T : Element> querySelectorAll(selectors: TagName<T>): NodeList<T>
Link copied to clipboard
fun releasePointerCapture(pointerId: Int)
Link copied to clipboard
open fun remove()
Link copied to clipboard
fun removeAttribute(qualifiedName: String)
Link copied to clipboard
fun removeAttributeNode(attr: Attr): Attr
Link copied to clipboard
fun removeAttributeNS(namespace: String?, localName: String)
Link copied to clipboard
fun <T : Node> removeChild(child: T): T
Link copied to clipboard
fun <T : Node> replaceChild(node: Node, child: T): T
Link copied to clipboard
open fun replaceChildren()
open fun replaceChildren(vararg nodes: String)
open fun replaceChildren(vararg nodes: Node)
Link copied to clipboard
open fun replaceWith(vararg nodes: String)
open fun replaceWith(vararg nodes: Node)
Link copied to clipboard
abstract fun requestContentUpdate()

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

Link copied to clipboard
fun requestFullscreenAsync(options: FullscreenOptions): Promise<Void>
Link copied to clipboard
fun requestPointerLockAsync(options: PointerLockOptions): Promise<Void>
Link copied to clipboard
fun scroll(options: ScrollToOptions): Promise<Void>?
fun scroll(x: Double, y: Double): Promise<Void>?
Link copied to clipboard
fun scrollBy(options: ScrollToOptions): Promise<Void>?
fun scrollBy(x: Double, y: Double): Promise<Void>?
Link copied to clipboard
fun scrollIntoView(options: ScrollIntoViewOptions): Promise<Void>?
Link copied to clipboard
fun scrollTo(options: ScrollToOptions): Promise<Void>?
fun scrollTo(x: Double, y: Double): Promise<Void>?
Link copied to clipboard
fun setAttribute(qualifiedName: String, value: String)
Link copied to clipboard
fun setAttributeNode(attr: Attr): Attr?
Link copied to clipboard
fun setAttributeNodeNS(attr: Attr): Attr?
Link copied to clipboard
fun setAttributeNS(namespace: String?, qualifiedName: String, value: String)
Link copied to clipboard
fun setHTML(html: String, options: SetHTMLOptions)
Link copied to clipboard
fun setHTMLUnsafe(html: String, options: SetHTMLUnsafeOptions)
fun setHTMLUnsafe(html: TrustedHTML, options: SetHTMLUnsafeOptions)
Link copied to clipboard
fun setPointerCapture(pointerId: Int)
Link copied to clipboard
fun showPopover(options: ShowPopoverOptions)
Link copied to clipboard
fun toggleAttribute(qualifiedName: String, force: Boolean): Boolean
Link copied to clipboard
fun togglePopover(options: TogglePopoverOptions): Boolean
Link copied to clipboard
fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions?): Observable<T>