🎁 (see ngokevin/angle for CLI version) Boilerplate for sharing A-Frame components.
JavaScript
Switch branches/tags
Nothing to show
Clone or download
Latest commit e44c750 Jan 18, 2017
Permalink
Failed to load latest commit information.
dist remove dist ex components Feb 25, 2016
examples add gh corner to example Sep 28, 2016
scripts fix unboil Jul 17, 2016
.gitignore work on readme trim Feb 25, 2016
LICENSE Initial commit Dec 18, 2015
README.md update readme Jan 18, 2017
index.js add linting script Jul 5, 2016
package.json dist on prepub Oct 11, 2016

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');