meshkraft-viewer
Version:
Web viewer SDK for Meshkraft Platform
58 lines (36 loc) • 1.39 kB
Markdown
# Meshkraft Viewer by *[ART Labs](https://artlabs.ai)*
Meshkraft is a no-coding platform for generating, optimizing and serving 3D models of your e-commerce products.
Meshkraft Viewer is the JS SDK for presenting models in web-AR.
## Install
The `<meshkraft-viewer>` web component can be used directly from various free CDNs such as [unpkg.com](https://unpkg.com)
You'll need to paste script code to the end of `<head>` section of your web page
```html
<script type="module" src="https://unpkg.com/meshkraft-viewer/dist/meshkraft-viewer.min.js"></script>
```
It can also be installed from [NPM](https://npmjs.org):
```sh
npm install meshkraft-viewer
```
## Usage
- First you will need to set your API Key with `init` command, once.
```javascript
MeshkraftViewer.init('API_KEY')
```
- After initialized, in specific product page, call SDK with product identifier (SKU)
```html
<meshskraft-viewer sku="SKU-123" />
```
SDK will do the rest.
## Options
##### sku (string) *required
SKU of your product. Identifier for 3D assets.
##### enable-ar (boolean)
Should enable AR button. Defaults to true
##### auto-rotate (boolean)
Should the models rotate automatically. Defaults to true
##### width (number)
Width of parent component. Defaults to %100
##### height (number)
Width of parent component. Defaults to 300px
#### config (object)
Scene and AR config. TBA.