@google/model-viewer
v4.1.0TypeScript
Easily display interactive 3D models on the web and in AR!
0/weekUpdated 10 months agoApache-2.0Unpacked: 37.3 MB
Published by smalls
npm install @google/model-viewer 
models - optionally in AR - easy to do, on as many browsers and devices as possible.
performance.
As new standards and APIs become available
to take advantage of them. If possible, fallbacks and polyfills will be
supported to provide a seamless development experience.
Demo • Documentation • Quality Comparisons (courtesy of Khronos)
Installing
$3
The
``sh`install peer dependency ThreeJS
npm install three install package
npm install @google/model-viewer
Finally, include the script in your project.
`js`
import '@google/model-viewer';
$3
It can also be used directly from various free CDNs such as jsDelivr and Google's own hosted libraries:
`html`
For more detailed usage documentation and live examples, please visit our docs
at modelviewer.dev!
$3
Our goal for
is to be a consistent, stable part of your web
platform while continuing to deliver cutting-edge features. We’ll always try
to minimize breaking changes, and to keep the component backwards compatible.
See our guide to contributing for more
information on backwards compatibility.For your production site you may want the extra stability that comes by
pinning to a specific version, and upgrading on your own schedule (after
testing).
If you’ve installed via NPM, you’re all set - you’ll only
upgrade when you run
npm update.
Note that three.js is a peer dependency, so that must also be installed, but can
be shared with other bundled code. Note that requires the
version of three.js we test on to maintain quality, due to frequent upstream
breaking changes. We strongly recommend you keep your three.js version locked to
's. If you must use a different version, npm will give you an
error which you can work around using their --legacy-peer-deps option, which
will allow you to go outside of our version range. Please do not file issues if
you use this option. Browser Support
is supported on the last 2 major versions of all evergreen
desktop and mobile browsers.| | 
Chrome | 
Firefox | 
Safari | 
Edge |
| -------- | --- | --- | --- | --- |
| Desktop | ✅ | ✅ | ✅ | ✅ |
| Mobile | ✅ | ✅ | ✅ | ✅ |
builds upon standard web platform APIs so that the performance,
capabilities and compatibility of the library get better as the web evolves.Development
To get started, follow the instructions in the main README.md file.
The following commands are available when developing
:Command | Description
------------------------------- | -----------
npm run build | Builds all distributable files
npm run build:dev | Builds a subset of distributable files (faster than npm run build)
npm run test | Run unit tests
npm run clean | Deletes all build artifacts
npm run dev | Starts tsc and rollup` in "watch" mode, causing artifacts to automatically rebuild upon incremental changes