NOTE: This version of the documentation tracks unstable development happening on A-Frame’s
masterbranch. If you wish to try it out, grab the unstable build. Otherwise, head to the documentation for the current 1.5.0 version
A-Frame exposes its public interface through the
global. This same interface is also exposed if requiring with CommonJS
|Base node prototype that A-Frame elements inherit from.
|Object of registered components.
|Object of registered geometries .
|Object of registered primitives.
|Function to register a component.
|Function to register a geometry.
|Function to register a primitive like registering an A-Frame elements similar to
|Function to register a material or shader.
|Object of registered shaders.
|Object of registered systems.
|Global three.js object.
|A-Frame utility modules.
|Version of A-Frame build.
|The object described above.
|Whether the client has native WebVR support.
It is possible to run A-Frame in Node.js to get access to its globals. The only catch is we need to supply a browser
window mock since Node.js lacks a
const jsdom = require("jsdom");
Although A-Frame can load in Node.js, A-Frame isn’t (yet) able to run any simulations at run time.