The <xr-asset-viewer> component
One custom element: poster first, three.js only when the visitor opens the viewer, and only the buttons the device supports.
Five-line integration
<script type="module" src="/js/xr-asset-viewer.js"></script>
<xr-asset-viewer src="/assets/sie-well.glb" poster="/assets/sie-well.avif"
usdz="/assets/sie-well.usdz" real-size="1.92 2.5 1.522" vr
alt="Round stone well with a small gable roof">
</xr-asset-viewer>npm: @trysac/xr-asset-viewer (publication pending).
Attributes
src | Model GLB (required). |
|---|---|
poster | Image shown before three.js loads and without WebGL. |
usdz | USDZ for Quick Look on iOS; without it there is no AR button on iPhone. |
alt | Model description for screen readers. |
real-size | "x y z" in metres; shows the real size, scaled. |
min-scale / max-scale | AR scale limits (0.25× and 4× by default). |
ar-label | AR button text (e.g. "View in your space"). |
vr | Offers VR when the browser supports it. |
Events
xr-ready | The 3D viewer loaded the model. |
|---|---|
xr-session-start / xr-session-end | detail.mode: "ar" or "vr". |
xr-placed | The model was placed in AR; detail.position in metres. |
xr-photo | AR canvas photo; detail.blob (PNG, never the camera feed). |
xr-error | Load or session failure; detail.message. |