Vizbl

API Reference

HTML attributes and supported values for the Room Viewer CDN build.

CDN API Reference

Use this page when you need the exact HTML attribute surface for @vizbl/room-viewer.

Required trigger marker

AttributeDescription
data-vizbl-room-viewer-dialogMarks an element as a Room Viewer trigger.

Product attributes

Shared attributes

AttributeRequiredDescription
data-vizbl-room-viewer-typeYesSupported values: poster, carpet.
data-vizbl-room-viewer-nameYesProduct name shown in the UI.
data-vizbl-room-viewer-languageNoSupported values: en, ru.

Poster attributes

AttributeRequiredDescription
data-vizbl-room-viewer-srcYesPublic poster image URL.
data-vizbl-room-viewer-widthYesPoster width used for scaling.
data-vizbl-room-viewer-heightYesPoster height used for scaling.

Carpet attributes

AttributeRequiredDescription
data-vizbl-room-viewer-tinuuidYesCarpet identifier used to resolve the model and material.

Supported values

data-vizbl-room-viewer-type

ValueMeaning
posterUses data-vizbl-room-viewer-src, data-vizbl-room-viewer-width, and data-vizbl-room-viewer-height.
carpetUses data-vizbl-room-viewer-tinuuid.

data-vizbl-room-viewer-language

Supported values: en, ru.

Notes

  • The browser must be able to reach poster src URLs directly.
  • Use the same attribute names everywhere on the trigger element.

Next steps

On this page