Skip to main content
These pages document Viewer 2 (@speckle/viewer 2.x), which was built for the object-data format used before 2026.9. Viewer 3 is not released. The bridge described here lets an existing Viewer 2 application consume current bundle-backed models, but it rebuilds the old object shape in memory and does not provide Viewer 3’s large-model capabilities. Without that bridge, the published Viewer 2 package has no bundle loader and a bundle version renders nothing. See Loading Speckle data for the available paths.
Speckle lets you view 3D models directly in your web browser. The Speckle viewer is the component that makes this possible, rendering large 3D models in your browser at rapid speeds. Speckle has made the Speckle viewer available as an Open Source project and freely available component which you can use within your own code or website. This section of the documentation explains what the Speckle viewer is and how to build upon it. We provide full documentation, explaining the concepts behind its design, introducing some simple and more advanced examples, and providing comprehensive documentation of its Application Programming Interface (API).

Loading Speckle data

A version’s data is a bundle of parquet files, not an object graph fetched from the objects endpoints. The published Viewer package converts object graphs, so it needs a bridge to render a bundle. The rest of the package is unaffected. Render pipelines, extensions, filtering, selection, queries, the world tree and view modes all work the same way, because the change is in where the data comes from, not in what the viewer does with it once converted.

Am I affected?

Load bundles

Load bundles yourself

Add about a dozen files to your app, keep the same published packages, and render bundles. Sample code and a step-by-step path.
The bridge is sample code rather than a package release, so you own the copy and it carries a date. The guide says what it does and does not cover. The bridge keeps your app on the object graph the bundle format replaced, by rebuilding that graph in memory. The format is built for streaming reads, sharded geometry, and querying properties without materialising objects. Getting the performance the format allows needs a viewer built for it. Plan for that, and treat the bridge as a way to keep working until it arrives.

Not the Viewer package

Two nearby cases have their own pages.
  • A data-only JavaScript app that reads Speckle data without rendering it, built on @speckle/objectloader or @speckle/objectloader2, should read the bundle directly rather than bridging to an object graph. Start from Building custom apps.
  • The 3D viewer in the web app is not this package. See 3D viewer.

Package reference

The API reference in this section documents the published package. The surface the bridge relies on, Loader, SpeckleLoader, WorldTree, and loadObject, is documented in Loaders, the Loader API, and the World tree API.
The documentation embeds live code sandboxes. Depending on your browser and extensions, these embeds might not work.
Try the viewer in the sandbox at viewer.speckle.systems.
Last modified on November 12, 2026