Migrating from 0.0.1

A prop-by-prop map from the 0.0.1 API to 1.0.0, and an honest account of why it is a clean break.

Why a clean break

1.0.0 is not a compatible upgrade. DashModelViewer is gone; there is no shim that keeps old code running.

That is a deliberate decision rather than an oversight, and the argument for the other choice was real: the package had roughly 253 downloads a month, and a deprecating wrapper would have cost little. What tipped it was that the parts most in need of changing — hotspots, AR defaults, and the complete absence of output props — could not be fixed while preserving the old surface. A compatibility layer would have frozen the exact shapes that made the component hard to use.

So: rename, and say so loudly.

Side by side

# 0.0.1
from dash_model_viewer import DashModelViewer

DashModelViewer(
    id="viewer",
    src="/assets/shoe.glb",
    alt="A shoe",
    cameraControls=True,
    arModes="webxr scene-viewer quick-look",   # you had to know to set this
    arButtonText="View in your space",
    hotspots=[
        {"slot": "hotspot-1", "position": "0 1 0", "text": "Sole",
         "children_classname": "label"},
    ],
)

# 1.0.0
import dash_model_viewer as dmv
from dash import html

dmv.ModelViewer(
    id="viewer",
    src="/assets/shoe.glb",
    alt="A shoe",
    camera_controls=True,
    # ar_modes now defaults to "webxr scene-viewer quick-look"
    children=[
        dmv.Slot(slot="hotspot-1", position="0 1 0",
                 class_name="label", children="Sole"),
        dmv.Slot(slot="ar-button",
                 children=html.Button("View in your space")),
    ],
)

Prop map

Hotspot dictionaries → Slot

The last row is the significant one. Camera-preset hotspots used to be declared inside the hotspot dict and handled invisibly by the component's JavaScript. They are now an ordinary callback, which means you can log them, animate them, gate them on auth, or compute them — see Camera and views.

Delete your clientside callbacks

If you copied the 0.0.1 examples you will have an assets/model_viewer_clientside.js and a clientside_callback for anything the component could not report. All of it is replaceable:

The AR default

Worth calling out separately because it changes behaviour silently rather than loudly. 0.0.1 shipped:

arModes = "basic_annotations scene-viewer quick-look"

basic_annotations is not an AR mode — it was a folder name in usage_tests/. webxr was therefore absent, and in-page WebXR AR never ran in a default configuration. If your code explicitly set arModes, you were unaffected; if it did not, you were running without WebXR and had no way to know.

You can now delete any explicit ar_modes="webxr scene-viewer quick-look" — that is the default. See Augmented reality.

Things that no longer exist

• camera["source"] — removed in 1.0.0 before release. The shim reports

camera movement only for user interaction (that is the echo suppression which stops a callback writing camera_orbit from re-triggering itself), so source could only ever hold the single string "user-interaction". A key with one possible value tells a reader nothing, and reading it invited the belief that some other value was reachable. The payload is now {"orbit", "target", "field_of_view"}. The suppression itself is unchanged.

• dash_model_viewer.DashModelViewer — renamed.
• The generated R and Julia bindings — removed; they were generated and unused.
• package-info.json inside the package — __version__ now comes from

installed metadata.

• The runtime CDN fetch of model-viewer 3.5.0 — the bundle ships in the wheel

at 4.3.1. If you relied on the CDN behaviour, dmv.configure(use_cdn=True) restores it.

Source: /migrating