Skip to main content

AROverlay

AROverlay adds a close button & floor detection icon & toast on WebXR Device API based webAR session.

import View3D, { AROverlay } from "@egjs/view3d";
import "@egjs/view3d/css/view3d-ar.min.css"; // If you're not using the bundled CSS (view3d-bundle.css)

const view3D = new View3D(...);

view3D.loadPlugins(new AROverlay({
toastText: "New toast message that will be placed on the bottom of the screen"
}));

Options

OptionTypeDefaultDescription
classNameobjectAROverlay.DEFAULT_CLASSOverride default class names
toastTextstring"Point your device downwards to find the ground and move it around."Toast text