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 re-use.
Boilerplate for sharing A-Frame components:
npm install && npm run unboilto rename and trim stuff. Don't forget to unboil.- Write your component.
- Build examples (
npm run devto watch for changes to build example bundles). npm publishand commit thedist/files.npm run ghpagesto share with people.- Share on Slack and awesome-aframe!
Examples:
- aframe-layout-component
- aframe-text-component
- aframe-extrude-and-lathe
- aframe-obj-loader-component
- aframe-physics-component
- aframe-template-component
--trim--
A example component for A-Frame.
| Property | Description | Default Value |
|---|---|---|
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>Install via NPM:
npm install aframe-example-componentThen register and use.
require('aframe');
require('aframe-example-component');