@egjs/view3d

中文文档
2.10.1发布于 2023/02/21MITTypeScriptESM + CJS近 30 天下载 9327

Fast & Customizable glTF 3D model viewer, packed with full of features!

原始使用文档
文档目录6 节
  1. 🔹 Features
  2. 🔹 Installation
  3. 🔹 Quick Start
  4. 🔹 Browser Support
  5. 🔹 Articles
  6. 🔹 License

View3D

npm (scoped) License Typescript GitHub Repo stars

Fast & Customizable glTF 3D model viewer, packed with full of features!

👉 Demo / API Document / Tutorial

🔹 Features

  • glTF Viewer based on the three.js
    • View, rotate, translate and zoom your glTF 3D models in the web.
    • Works on both 🖥️ Desktop & 📱 Mobile
    • Customize your viewer with options like autoplay, skybox, and shadow
  • Augmented Reality
    • View3D supports Augmented Reality based on WebXR, Scene Viewer, and AR Quick Look
    • You can see, rotate, move, and scale the 3D model on the floor & wall in our AR sessions.
  • Supports compressed glTF 2.0 models
    • View3D can display compressed glTF models with the following extensions.
      • KHR_draco_mesh_compression
      • EXT_meshopt_compression
      • KHR_texture_basisu
  • Typescript-based

🔹 Installation

npm i @egjs/view3d
# OR
yarn add @egjs/view3d

🔹 Quick Start

@egjs/view3d requires one wrapper & one canvas element to be initialized.

<div id="view3d" class="view3d-wrapper">
  <canvas class="my-canvas"></canvas>
</div>

Then you can use it like

import View3D from "@egjs/view3d";
import "@egjs/view3d/css/view3d-bundle.min.css";

const canvasEl = document.querySelector("#view3d");
const view3d = new View3D(canvasEl, {
  src: "URL_TO_YOUR_3D_MODEL",
  envmap: "URL_TO_YOUR_HDR_IMAGE",
});

// or just

const view3d = new View3D("#view3d");

See detailed explanation on our Tutorial

🔹 Browser Support

View3D is available for the last two major versions of all evergreen desktop and mobile browsers.

🔹 Articles

🔹 License

Copyright (c) 2020-present NAVER Corp.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

版本与发布记录

@egjs/view3d 共发布 45 个版本,首次发布于 2020/09/18;过去 12 个月发布了 0 个版本。

版本发布日期距今
2.10.1latest2023/02/213 年前
2.10.02023/01/173 年前
2.9.12022/11/084 年前
2.9.1-beta.0next2022/11/044 年前
2.9.02022/11/024 年前
2.9.0-beta.62022/10/124 年前

关于 @egjs/view3d 的常见问题

@egjs/view3d 是什么?

Fast & Customizable glTF 3D model viewer, packed with full of features!

如何安装 @egjs/view3d?

在项目目录运行 npm install @egjs/view3d,或使用 pnpm add / yarn add / bun add。

@egjs/view3d 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@egjs/view3d 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@egjs/view3d 可以商用吗?

@egjs/view3d 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@egjs/view3d 的下载量有多少?

根据 npm 官方下载统计,@egjs/view3d 在 2026/10/13 – 2026/11/11 这 30 天内被下载 9,327 次,日均约 311 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@egjs/view3d 还在维护吗?

最新版本 2.10.1 发布于 2023/02/21(3 年前);至今共发布 45 个版本,其中过去 12 个月发布了 0 个;首次发布于 2020/09/18。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。