DOM overlays for WebXRLimited availability
A DOM overlay shows 2D DOM content as an interactive, transparent layer on top of a WebXR application's WebGL content and camera image.
Not yet supported in all major browsers — check the table and provide a fallback.
Browser support
DesktopChrome
1–81Not supported
83+Supportedsince May 19, 2020
Current: 155Edge
12–81Not supported
83+Supportedsince May 21, 2020
Current: 154Firefox
✕Not supportedup to 157
Current: 157Safari
✕Not supportedup to 27
Current: 27MobileChrome Android
18–81Not supported
83+Supportedsince May 19, 2020
Current: 155Firefox Android
✕Not supportedup to 157
Current: 157Safari iOS
✕Not supportedup to 27
Current: 27How to use
Not supported in Firefox, Safari, Firefox Android, Safari iOS. Use feature detection below and provide a fallback (or a polyfill) for those browsers.
Example
Full syntax and examples are on MDN: beforexrselect event.
Feature detection
JS · check before using
if ("XRSession" in globalThis && "domOverlayState" in XRSession.prototype) {
// XRSession.domOverlayState is available
}Documentation (MDN)
Specification
Sub-features
Support for each part of the feature (3). The overall table above shows when the whole feature works.
| Sub-feature | Chrome | Edge | Firefox | Safari | Chrome Android | Firefox Android | Safari iOS |
|---|---|---|---|---|---|---|---|
| Element.beforexrselect_event | 83 | 83 | ✕ | ✕ | 83 | ✕ | ✕ |
| XRSession.domOverlayState | 83 | 83 | ✕ | ✕ | 83 | ✕ | ✕ |
| xr-overlay | 83 | 83 | ✕ | ✕ | 83 | ✕ | ✕ |