简体中文
EnglishWhere to Find Documentation, Examples, and Tools
Updated
The official home for <model-viewer> is modelviewer.dev, the project site for the web component that displays interactive 3D models on the web and in AR. From that one site you can reach four main resources: Documentation (introduction, FAQ, and more), Examples (advanced usage), the API Reference, and the Editor, which lets you test your 3D models and download a starter website. If you already know which of those you need, go straight to it; the sections below explain what each one is for.
What modelviewer.dev is
<model-viewer> is a component for easily displaying interactive 3D models on the web and in AR. The site at modelviewer.dev is its documentation and tooling hub rather than a product marketing page — it exists to help you get a model rendering and then to help you go further.
The four main resources
| Resource | What it gives you | Use it when |
|---|---|---|
| Documentation | Getting Started, Introduction, FAQ, and more | You are new to the component or need a conceptual answer |
| Examples | Advanced usage demos | You have a basic model working and want to do more |
| API Reference | The component's interface | You need to know which attributes, properties, or events exist |
| Editor | Test your 3D models and download a starter website | You want to check a model or scaffold a project quickly |
Documentation
Start here for the Quick Start and Getting Started material, plus the FAQ and an Introduction. This is the place to answer "how do I get a model on a page" and "why is my model behaving this way" before you dig into the API.
Examples
The Examples section covers advanced usage. Treat it as a set of working references: find the example closest to what you want, then adapt it rather than building from scratch.
API Reference
The API Reference documents the component's interface. Use it when you know what you want to change but not what it is called.
Editor
The Editor has two jobs: test your 3D models and download a starter website. It is the fastest way to confirm a model file loads and looks right, and to leave with a working starting point instead of an empty page.
Browser support and AR requirements
<model-viewer> is supported on the last two major versions of all evergreen desktop and mobile browsers, plus the last two versions of Safari (on macOS and iOS).
AR features are a separate question. These browser features are only needed if you want to use WebXR in ar-modes:
| Feature | Status |
|---|---|
| WebXR Device API | Natively supported |
| WebXR HitTest API | Available with polyfill |
| WebXR DOM Overlay API | Behind a flag, unstable |
| (remaining listed feature) | Not available |
The practical reading: basic model display has broad support, but WebXR-based AR depends on features that are not uniformly available — one is polyfilled, one is unstable behind a flag, and one is not available at all. Check this table before committing to a WebXR AR experience.
A sensible order of operations
- Open modelviewer.dev and read the Getting Started / Quick Start material.
- Load your model in the Editor to confirm it renders, then download a starter website.
- When you need more than the basics, work from Examples (advanced usage).
- When you need a specific attribute, property, or event, look it up in the API Reference.
- Before shipping AR, verify your target browsers against the Browser Support table above.
Notes on the demo content
The site's featured model is the Neil Armstrong Space Suit, provided by the Smithsonian Digitization Programs Office and the National Air and Space Museum, with usage conditions applying. The site itself is ©Copyright 2018–2025 Google Inc., licensed under the Apache License 2.0.