From 298b1c9c41a687a48fdf253858ef65371974af0a Mon Sep 17 00:00:00 2001 From: James Maki Date: Fri, 12 Jan 2024 11:02:57 -0800 Subject: [PATCH] Update xr-mode-ui.md (#5420) * Update xr-mode-ui.md Corrected default values for enterVREnabled and enterAREnabled. Added examples to clarify customization options. Seperated out "one of" into seperate column for greater clarity. * Updated formatting and removed extra sections. * Updated the general description --- docs/components/xr-mode-ui.md | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/docs/components/xr-mode-ui.md b/docs/components/xr-mode-ui.md index 4da34e673a0..9ebadc2c86c 100644 --- a/docs/components/xr-mode-ui.md +++ b/docs/components/xr-mode-ui.md @@ -6,11 +6,9 @@ parent_section: components source_code: src/components/scene/xr-mode-ui.js --- -The xr-mode-ui component allows configuring and disabling of UI such as the enter VR / AR button, compatibility -modal, and orientation modal for mobile. The xr-mode-ui component applies only +The xr-mode-ui component configures or disables the enter VR and AR buttons. Buttons only display if the browser supports the corresponding modes (AR or VR). The xr-mode-ui component applies only to the [`` element][scene]. If we wish to simply toggle the UI, use CSS instead. - ## Example ```html @@ -19,22 +17,22 @@ to the [`` element][scene]. If we wish to simply toggle the UI, use CSS ## Properties -| Property | Description | Default Value | -|-----------------------|---------------------------------------------------------------------|---------------| -| cardboardModeEnabled | Enables the now deprecated cardboard mode. | false | -| 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. | '' | -| enterVREnabled | If the VR button is displayed when applicable | false | -| enterARButton | Selector to a custom AR button. On click, the button will enter AR. | '' | -| enterAREnabled | If the AR button is displayed when applicable | false | -| XRMode | If the AR, VR button or both will be displayed. One of 'ar', 'vr' or 'xr'.| vr | +| Property | Description | Default Value | +| - | - | - | +| cardboardModeEnabled | Enables the now deprecated cardboard mode. | false | +| 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. | '' | +| enterVREnabled | If the VR button is displayed when applicable.| true | +| enterARButton | Selector to a custom AR button. On click, the button will enter AR. | '' | +| enterAREnabled | If the AR button is displayed when applicable. | true | +| XRMode | If the AR button, VR button, or both buttons will be displayed. | vr | -### Specifying a Custom Enter VR Button +### Specifying Custom Enter VR and AR Buttons ```html - + xr-mode-ui="enterVRButton: #myEnterVRButton; enterARButton: #myEnterARButton; XRMode: xr;"> +