# @speckle/viewer

> A 3d viewer for Speckle, based on threejs.

Latest version **2.31.14** (published 2026-06-15) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @speckle/viewer
pnpm add @speckle/viewer
yarn add @speckle/viewer
bun add @speckle/viewer
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 2.31.14 |
| Published | 2026-06-15 |
| First published | 2021-03-25 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=18.0.0 |
| Dependencies | 14 |
| Unpacked size | 2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 841 |
| Author | AEC Systems |
| Maintainers | dimitrie, specklesystems |
| Keywords | speckle, aec, 3d, 3d viewer, threejs |

## Links

- npm: https://www.npmjs.com/package/@speckle/viewer
- Repository: https://github.com/specklesystems/speckle-server
- Homepage: https://speckle.systems
- npm.io page: https://npm.io/package/@speckle/viewer

## Dependencies (14)

- [flat](https://npm.io/package/flat.md) ^5.0.2
- [three](https://npm.io/package/three.md) ^0.140.0
- [earcut](https://npm.io/package/earcut.md) 3.0.1
- [js-logger](https://npm.io/package/js-logger.md) 1.6.1
- [lodash-es](https://npm.io/package/lodash-es.md) ^4.17.21
- [polylabel](https://npm.io/package/polylabel.md) 2.0.1
- [type-fest](https://npm.io/package/type-fest.md) ^4.15.0
- [tree-model](https://npm.io/package/tree-model.md) 1.0.7
- [@types/flat](https://npm.io/package/@types/flat.md) ^5.0.2
- [three-mesh-bvh](https://npm.io/package/three-mesh-bvh.md) 0.5.17
- [@speckle/shared](https://npm.io/package/@speckle/shared.md) ^2.31.14
- [string-to-color](https://npm.io/package/string-to-color.md) ^2.2.2
- [troika-three-text](https://npm.io/package/troika-three-text.md) 0.52.4
- [@speckle/objectloader2](https://npm.io/package/@speckle/objectloader2.md) ^2.31.14

## Recent versions

- 2.31.14 (latest) — 2026-06-15
- 2.23.4-alpha2 (viewer-next) — 2024-12-18
- 2.6.1 (next) — 2022-05-30
- 2.4.2-alpha.0 (canary) — 2022-04-06
- 2.31.11 — 2026-06-05
- 2.31.10 — 2026-06-04
- 2.28.0 — 2026-01-30
- 2.27.2 — 2026-01-27
- 2.27.1 — 2026-01-15
- 2.26.9 — 2026-01-06
- 2.26.8 — 2025-11-10
- 2.26.7 — 2025-11-05
- 2.26.6 — 2025-10-31
- 2.26.5 — 2025-10-18
- 2.26.4 — 2025-10-16
- … 198 more at https://npm.io/package/@speckle/viewer/versions

## README

# The Speckle Viewer

[![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Community forum users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fspeckle.community&style=flat-square&logo=discourse&logoColor=white)](https://speckle.community) [![website](https://img.shields.io/badge/https://-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) [![docs](https://img.shields.io/badge/docs-speckle.guide-orange?style=flat-square&logo=read-the-docs&logoColor=white)](https://speckle.guide/dev/) [![npm version](https://badge.fury.io/js/%40speckle%2Fviewer.svg)](https://badge.fury.io/js/%40speckle%2Fviewer)

## Documentation

Complete documentation [here](https://speckle.guide/viewer/)
Migration guide [here](https://speckle.notion.site/Migration-Guide-b2b4118d34b544e9b9a848714348e7c7)

## Examples

You can find readily available examples in the documentation [here](https://speckle.guide/viewer/basic-example.html)

## Development

- run `yarn` in the repo root to install and link all required dependencies.
- run `yarn dev` in the viewer package (here) to start a dev build with automatic code refresing of the viewer code.
- run `yarn dev` in the viewer-sandbox package to start the viewer sandbox.

## Feedback

We would love to hear your feedback in [this forum thread](https://speckle.community/t/seeking-feedback-on-the-new-viewer-api-structure/7231).

## Community

If in trouble, the Speckle Community hangs out on [the forum](https://speckle.community). Do join and introduce yourself! We're happy to help.

## License

Unless otherwise described, the code in this repository is licensed under the Apache-2.0 License. If you have any questions, don't hesitate to get in touch with us via [email](mailto:hello@speckle.systems).

---
_Source: https://npm.io/package/@speckle/viewer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._