Skip to content
🎁 (see ngokevin/angle for CLI version) Boilerplate for sharing A-Frame components.
JavaScript
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist
examples
scripts
.gitignore
LICENSE
README.md
index.js
package.json

README.md

aframe-component-boilerplate

The component boilerplate has been deprecated. Use the A-Frame angle CLI instead to set up a component template:

npm install -g angle
angle initcomponent

Usage (Old)

This is not at all means required for writing an A-Frame component. It is intended for publishing and sharing a component for the community to reuse.

  1. npm install && npm run unboil to rename and trim stuff.
  2. Write your component.
  3. Build examples (npm run dev to watch for changes to build example bundles).
  4. npm publish and commit the dist/ files.
  5. npm run ghpages to share with people.
  6. Share on Slack, awesome-aframe, and the Registry!

--trim--

aframe-example-component

A example component for A-Frame.

API

Property Description Default Value

Installation

Browser

Install and use by directly including the browser files:

<head>
  <title>My A-Frame Scene</title>
  <script src="https://aframe.io/releases/0.2.0/aframe.min.js"></script>
  <script src="https://rawgit.com/ngokevin/aframe-component-boilerplate/master/dist/aframe-example-component.min.js"></script>
</head>

<body>
  <a-scene>
    <a-entity example="exampleProp: exampleVal"></a-entity>
  </a-scene>
</body>

npm

Install via npm:

npm install aframe-example-component

Then register and use.

require('aframe');
require('aframe-example-component');
You can’t perform that action at this time.