Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update xr-mode-ui.md #5420

Merged
merged 4 commits into from
Jan 12, 2024
Merged

Update xr-mode-ui.md #5420

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c82aef8
Update xr-mode-ui.md
Omegahed Dec 23, 2023
7ae7df0
Merge branch 'aframevr:master' into patch-1
Omegahed Jan 12, 2024
dba106b
Updated formatting and removed extra sections.
Omegahed Jan 12, 2024
dbadea8
Updated the general description
Omegahed Jan 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 13 additions & 15 deletions docs/components/xr-mode-ui.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 [`<a-scene>` element][scene]. If we wish to simply toggle the UI, use CSS instead.


## Example

```html
Expand All @@ -19,22 +17,22 @@ to the [`<a-scene>` 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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dmarcos I've condensed the three sections back down to one. Hopefully, this is more concise and helps to clarify.

```html
<a-scene
xr-mode-ui="enterVRButton: #myEnterVRButton; enterARButton: #myEnterARButton">
<!-- Style the button with images or whatever. -->
xr-mode-ui="enterVRButton: #myEnterVRButton; enterARButton: #myEnterARButton; XRMode: xr;">
<!-- Style the button with images and/or custom CSS. -->
<a id="myEnterVRButton" href="#"></a>
<a id="myEnterARButton" href="#"></a>
</a-scene>
Expand Down
Loading