@playcanvas/web-components
v0.2.2
Published
Web Components for the PlayCanvas Engine
Downloads
364
Maintainers
Readme
PlayCanvas Web Components
| User Guide | API Reference | Examples | Blog | Forum | Discord |
PlayCanvas Web Components are a set of custom HTML elements for building 3D interactive web apps. Using the declarative nature of HTML makes it both easy and fun to incorporate 3D into your website. Check out this simple example:
<!-- A lit sphere -->
<pc-app>
<pc-scene>
<pc-entity name="camera" position="0 0 3">
<pc-camera></pc-camera>
</pc-entity>
<pc-entity name="light" rotation="45 45 0">
<pc-light></pc-light>
</pc-entity>
<pc-entity name="ball">
<pc-render type="sphere"></pc-render>
</pc-entity>
</pc-scene>
</pc-app>
Examples
See PlayCanvas Web Components in action here: https://playcanvas.github.io/web-components/examples
Usage
Please see the Getting Started Guide for installation and usage instructions.
Development
Setting Up Local Development
Clone the repository:
git clone https://github.com/playcanvas/web-components.git cd web-components
Install dependencies:
npm install
Build the library in watch mode and start the development server:
npm run dev
Open http://localhost:3000/examples/ in your browser to see the examples.
Building
To build the library:
npm run build
The built files will be available in the dist
directory.
API Documentation
To generate API documentation:
npm run docs
The documentation will be generated in the docs
directory.