API Reference
JavaScript
Options and data attributes for the JavaScript package.
RoomViewerResourceType
type RoomViewerResourceType = 'wallart' | 'rugs' | 'flooring' | 'wall-panel'RoomViewerDimensionUnit
type RoomViewerDimensionUnit = 'm' | 'cm' | 'in'RoomViewerDisplayUnit
type RoomViewerDisplayUnit = 'cm' | 'in'Options
Prop
Type
Data Attributes
| Attribute | Required | Default | Description |
|---|---|---|---|
data-neurodyn-room-viewer-dialog | No | - | Marks an element for the embed build. |
data-neurodyn-room-viewer-type | Yes | - | Resource type. Use wallart, rugs, flooring, or wall-panel. |
data-neurodyn-room-viewer-src | When type is wallart | - | Wall-art image URL. |
data-neurodyn-room-viewer-tinuuid | When type is rugs, flooring, or wall-panel | - | The object's tinuuid. |
data-neurodyn-room-viewer-room-id | No | - | Initial Room ID from the available catalog. Skips the initial interior chooser; unavailable Rooms open the chooser. Empty values do nothing. |
data-neurodyn-room-viewer-name | Yes | - | Title shown in the dialog header. |
data-neurodyn-room-viewer-width | No | - | Wall-art width. Used when type is wallart. |
data-neurodyn-room-viewer-height | No | - | Wall-art height. Used when type is wallart. |
data-neurodyn-room-viewer-dimension-unit | No | m | Unit used by wall-art width and height. Use m, cm, or in. |
data-neurodyn-room-viewer-display-unit | No | cm | Unit used to display UI measurements. Use cm or in. |
data-neurodyn-room-viewer-language | No | User locale | UI language override. Use en, ru, or ar. |
data-neurodyn-room-viewer-api-key | Yes | - | Public API key sent as x-api-key. Not needed when source is shopify. |
data-neurodyn-room-viewer-source | No | default | Backend source mode. Use default or shopify. |
data-neurodyn-room-viewer-disable-close | No | false | Set to true to hide close controls and prevent dismissal. |