Embed loader reference
Every container attribute the embed loader reads, for both widgets, in one place.
Available onFreePlusPro
One script, https://cdn.rentalbeam.com/v1/embed.js, powers both widgets. It scans the page for container elements and reads the attributes below off each one. This page is a flat reference; the individual guides linked from each row explain the behavior in context.
Availability calendar - .rentalbeam-calendar
.rentalbeam is the legacy class name and is accepted forever alongside it.
| Attribute | Values | Description |
|---|---|---|
data-rental-id | string | Calendar ID for a single rental. Required unless data-collection-id is set. |
data-collection-id | string | Collection ID - routes to the collection availability embed instead. See Collections. |
data-view | combined | timeline | tabs | Collection view mode. Only used with data-collection-id; defaults to combined. |
data-months-per-row | integer 1-15 | Month columns per row. Default 3. |
data-rows | integer 1-15 | Rows of months. Default 1. |
data-month-scale | float 0.8-1.6 | Scale multiplier for each month card. Default 1.0. |
data-theme | light | dark | Forces a theme. Omit to auto-match the host page - see URL parameters. |
data-calendar-language | string | Forces the widget language to one of the 24 supported codes. See Languages. |
data-calendar-id, id | string | Legacy id attributes from previously issued snippets. Still accepted; prefer data-rental-id in new snippets. |
Booking widget - .rentalbeam-booking-form
| Attribute | Values | Description |
|---|---|---|
data-rental-id | string | Booking widget ID for a single rental. Required unless data-collection-id is set. |
data-collection-id | string | Collection ID - routes to the collection booking widget. See Collections. |
data-picker | cards | dropdown | Collection member-picker mode. Only used with data-collection-id; omit for the dates-first default. |
data-multi-request | "true" | Lets a guest request additional collection members for the same dates. Only used with data-collection-id. |
data-rb-entry | "searchbar" | Renders a compact search bar instead of the full form. See Embed the booking widget. |
data-coupon | string | Auto-applies a coupon code on load. |
data-rb-checkin | YYYY-MM-DD | Prefills check-in. |
data-rb-checkout | YYYY-MM-DD | Prefills check-out. |
data-rb-guests | integer | Prefills guest count. |
data-theme | light | dark | Forces a theme. Omit to auto-match the host page. |
data-calendar-language | string | Forces the widget language to one of the 24 supported codes. |
data-calendar-id, id | string | Legacy id attributes from previously issued snippets. Still accepted; prefer data-rental-id in new snippets. |
Opening the widget programmatically
The loader also installs window.RentalBeam.openBooking(...) for launching the booking widget from your own button or search bar - see Embed the booking widget.
Every attribute here is additive and optional beyond the id - a bare container with just
data-rental-id renders the default widget. Attributes not listed here, and any legacy id form not listed above, are not read by the loader.