Skip to content

Commit

Permalink
Fix references to the old vr-mode-ui component
Browse files Browse the repository at this point in the history
  • Loading branch information
dmarcos committed Oct 24, 2023
1 parent 9ef892c commit d4c9306
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
10 changes: 5 additions & 5 deletions docs/components/xr-mode-ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@ title: xr-mode-ui
type: components
layout: docs
parent_section: components
source_code: src/components/scene/vr-mode-ui.js
source_code: src/components/scene/xr-mode-ui.js
---

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
The xr-mode-ui component allows disabling of UI such as an Enter VR button, compatibility
modal, and orientation modal for mobile. 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
<a-scene vr-mode-ui="enabled: false"></a-scene>
<a-scene xr-mode-ui="enabled: false"></a-scene>
```

## Properties
Expand All @@ -34,7 +34,7 @@ to the [`<a-scene>` element][scene]. If we wish to simply toggle the UI, use CSS

```html
<a-scene
vr-mode-ui="enterVRButton: #myEnterVRButton; enterARButton: #myEnterARButton">
xr-mode-ui="enterVRButton: #myEnterVRButton; enterARButton: #myEnterARButton">
<!-- Style the button with images or whatever. -->
<a id="myEnterVRButton" href="#"></a>
<a id="myEnterARButton" href="#"></a>
Expand Down
4 changes: 2 additions & 2 deletions docs/core/scene.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Components can be attached to the scene as well as entities:
[keyboard-shortcuts]: ../components/keyboard-shortcuts.md
[inspector]: ../introduction/visual-inspector-and-dev-tools.md
[stats]: ../components/stats.md
[vr-mode-ui]: ../components/vr-mode-ui.md
[xr-mode-ui]: ../components/xr-mode-ui.md

A-Frame ships with a few components to configure the scene:

Expand All @@ -102,7 +102,7 @@ A-Frame ships with a few components to configure the scene:
- [keyboard-shortcuts][keyboard-shortcuts] - Toggle keyboard shortcuts.
- [inspector][inspector] - Inject the A-Frame Inspector.
- [stats][stats] - Toggle performance stats.
- [vr-mode-ui][vr-mode-ui] - Toggle UI for entering and exiting VR.
- [xr-mode-ui][xr-mode-ui] - Toggle UI for entering and exiting VR.

## Running Content Scripts on the Scene

Expand Down

0 comments on commit d4c9306

Please sign in to comment.