Vizbl

Quick Start

Add Room Viewer to a page with the CDN script.

@vizbl/room-viewer lets users preview how a poster or carpet can look inside a room.

It works through HTML data-* attributes, so you can connect it to buttons, links, cards, or any other clickable element.

Installation

Load the browser bundle on the page where you want to use Room Viewer.

<script
  defer
  src="https://unpkg.com/@vizbl/room-viewer@latest/dist/room-viewer.bundle.min.js"
></script>

<button
  data-vizbl-room-viewer-dialog
  data-vizbl-room-viewer-type="poster"
  data-vizbl-room-viewer-resource="https://example.com/poster.jpg"
  data-vizbl-room-viewer-name="Abstract Poster"
  data-vizbl-room-viewer-width="1"
  data-vizbl-room-viewer-height="1.5"
>
  Preview in room
</button>

Use a fixed package version instead of @latest when you need predictable deployments.

Next steps

On this page