vr-mode-ui

Note: This documentation is for the old 1.1.0 version of A-Frame. Check out the documentation for the current 1.6.0 version

The vr-mode-ui component allows disabling of 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. If we wish to simply toggle the UI, use CSS instead.

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.	‘’
enterARButton	Selector to a custom AR button. On click, the button will enter AR.	‘’

Specifying a Custom Enter VR Button

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