troax-model-viewer v0.1.10

Troax Model Viewer

This is a private project for the company Troax and their website for their and only their uses.

It will display 3D model in either as a Web Component DOM element from a JS file or as a npm downloadable package.

The whole plugin is a wrapper of Googles model-viewer.

Usage

There are two ways we recommend for using this web components.

Script tag

• Put a script tag similar to this <script src='https://unpkg.com/troax-model-viewer'></script> in the head of your index.html
• Then you can use the element anywhere in your template, JSX, html etc

Node Module

• Run npm install troax-model-viewer
• Put a script tag similar to this <script src='node_modules/troax-model-viewer/dist/troax-model-viewer.esm.js'></script> in the head of your index.html
• Then you can use the element anywhere in your template, JSX, html etc

Usage

Use the tag with some attribute to change its behaviour.

• src points to the 3D GLB model that is associated with the uploaded file i a Troaxs S3 bucket. You'll have to point out the directory from the models catalog. For example: <troax-model-viewer src="Machine Guarding/Doors/Double Hinged Door.glb"></troax-model-viewer>
  • You can also fetch the model by their unique ID: <troax-model-viewer src="fb890921"></troax-model-viewer>
• ar it's the flag that adds the AR feature for the model where a button is added under the view to switch to the AR view. You can just add the attribute AR with no value in it.

Check this readme file file for more information about the different attributes that can be added.