🛠 NOTE: Bleeding edge fork

The primary @google/model-viewer repo is a hefty 2GB+ monorepo that is currently in fast-track development, meaning important changes are coming thick and fast - too fast and unstable for npmjs(!). This clone repo simply adds a new 'release' branch in an attempt to maintain a bleeding edge, npm installable and <scriptable> version for development purposes:

npm install https://github.com/theprojectsomething/model-viewer/tarball/model-viewer-release

<script type="module" src="https://ghcdn.rawgit.org/theprojectsomething/model-viewer/model-viewer-release/dist/model-viewer.js"></script>
<script nomodule src="https://ghcdn.rawgit.org/theprojectsomething/model-viewer/model-viewer-release/dist/model-viewer-umd.js"></script>

For current 'stable' releases please use the npmjs instructions below.

===

🛠 Status: In Development

<model-viewer> is currently in development. It's on the fast track to a 1.0 release, so we encourage you to use it and give us your feedback, but there are things that haven't been finalized yet and you can expect some changes.

<model-viewer>

<model-viewer> is a web component that makes rendering interactive 3D models - optionally in AR - easy to do, on as many browsers and devices as possible. <model-viewer> strives to give you great defaults for rendering quality and performance.

As new standards and APIs become available <model-viewer> will be improved to take advantage of them. If possible, fallbacks and polyfills will be supported to provide a seamless development experience.

Demo • Documentation • Kanban • Quality Tests

Installing

The <model-viewer> web component can be installed from NPM:

npm install @google/model-viewer

It can also be used directly from various free CDNs such as unpkg.com:

<script type="module" src="https://unpkg.com/@google/model-viewer/dist/model-viewer.js"></script>
<script nomodule src="https://unpkg.com/@google/model-viewer/dist/model-viewer-legacy.js"></script>

For more detailed usage documentation and live examples, please visit our docs at modelviewer.dev!

Browser Support

<model-viewer> is supported on the last 2 major versions of all evergreen desktop and mobile browsers. <model-viewer> is also supported on IE11.

	Chrome	Firefox	Safari	Edge	IE11
Desktop	✅	✅	✅	✅	✅
Mobile	✅	✅	✅	✅	N/A

<model-viewer> builds upon standard web platform APIs so that the performance, capabilities and compatibility of the library get better as the web evolves.

However, not all browsers support all of these features today. Check out POLYFILLS.md to learn how to polyfill for maximum browser compatibility!

Development

To get started, follow the instructions in the main README.md file.

The following commands are available when developing <model-viewer>:

Command	Description
npm run build	Builds all <model-viewer> distributable files
npm run build:dev	Builds a subset of distributable files (faster than npm run build)
npm run test	Run <model-viewer> unit tests
npm run clean	Deletes all build artifacts
npm run create-legacy-bundles	Generates IE11-compatible bundles (run npm run build first)
npm run dev	Starts tsc and rollup in "watch" mode, causing artifacts to automatically rebuild upon incremental changes