Skip to content

Commit c112bf3

Browse files
author
Chris Car
committed
modified README
1 parent c3f97b8 commit c112bf3

File tree

2 files changed

+40
-1
lines changed

2 files changed

+40
-1
lines changed

‎README.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,40 @@
11
# aframe-ui-modal-component
2+
3+
Create a modal dialog or floating menu in A-Frame.
4+
5+
### Properties
6+
7+
| Property | Description | Default Value |
8+
| --------- | ----------- | ------------- |
9+
| trigger | Event to make dialog or menu visible. | `click` |
10+
| zpos | Position the dialog or menu on the z-axis. In meters. | -4 |
11+
12+
### Usage
13+
14+
#### Browser Installation
15+
16+
Install and use by directly including the [browser files](dist):
17+
18+
```html
19+
<head>
20+
<title>My A-Frame Scene</title>
21+
<script src="https://aframe.io/releases/0.2.0/aframe.min.js"></script>
22+
<script src="https://rawgit.com/IdeaSpaceVR/aframe-ui-modal-component/master/dist/aframe-ui-modal-component.min.js"></script>
23+
</head>
24+
25+
<body>
26+
<a-scene>
27+
<a-entity position="0 1.8 5">
28+
<a-entity camera look-controls></a-entity>
29+
</a-entity>
30+
31+
<a-entity ui-modal visible="false">
32+
<a-plane width="3" height="1" color="red" position="0 -1.2 0"></a-plane>
33+
<a-plane width="3" height="1" color="green" position="0 0 0"></a-plane>
34+
<a-plane width="3" height="1" color="blue" position="0 1.2 0"></a-plane>
35+
</a-entity>
36+
37+
<a-sky src="images/sky.jpg"></a-sky>
38+
</a-scene>
39+
</body>
40+
```

‎index.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* UI Modal component for A-Frame.
2+
* UI modal component for A-Frame.
33
*/
44

55
if (typeof AFRAME === 'undefined') {

0 commit comments

Comments
 (0)