Element: beforexrselect event

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The beforexrselect event is fired before WebXR select events (select, selectstart, selectend) are dispatched. It can be used to suppress XR world input events while the user is interacting with a DOM overlay UI.

This event bubbles, is cancelable and is composed.

Syntax

Use the event name in methods like addEventListener(), or set an event handler property.

js
addEventListener("beforexrselect", (event) => {});

onbeforexrselect = (event) => {};

Event type

An XRSessionEvent. Inherits from Event.

Event XRSessionEvent

Event properties

session Read only

The XRSession to which the event refers.

Event availability

The beforexrselect event is a global event and available to the following interfaces:

Examples

To suppress WebXR select events (select, selectstart, selectend), an application can listen for the beforexrselect event. The event bubbles, so a call to preventDefault() on the DOM overlay element will prevent any WebXR select events within this container allowing interaction with the DOM element and avoiding duplicate event input to the XR world.

js
document
  .getElementById("xr-overlay")
  .addEventListener("beforexrselect", (ev) => ev.preventDefault());

Specifications

Specification
WebXR DOM Overlays Module
# onbeforexrselect

Browser compatibility

BCD tables only load in the browser

See also