vr-mode-ui

NOTE: This version of the documentation tracks unstable development happening on A-Frame’s master branch. If you wish to try it out, grab the unstable build. Otherwise, head to the documentation for the current 0.8.0 version

The vr-mode-ui component toggles UI such as an Enter VR button, compatibility modal, and orientation modal for mobile. The vr-mode-ui component applies only to the <a-scene> element.

Example

<a-scene vr-mode-ui="enabled: false"></a-scene>

Properties

Property Description Default Value
enabled Whether or not to display UI related to entering VR. true
enterVRButton Selector to a custom VR button. On click, the button will enter VR. ‘’

Specifying a Custom Enter VR Button

<a-scene vr-mode-ui="enterVRButton: #myEnterVRButton">
<!-- Style the button with images or whatever. -->
<a id="myEnterVRButton" href="#"></a>
</a-scene>