Possible data-attributes for the widget

Modified on Wed, 18 Feb at 10:42 AM

Data-attributes can be added to configure the Briq widget to better match your website. Add them after the data-domain attribute as shown in the widget script implementation guide.


Domain attribute (required)


data-domain (required)

Configures the widget to display deals and products of the specified business unit.


Value

The Briq domain name of your business unit, as displayed in the Briq app. Available via briq.app > Settings > General.



Appearance attributes


data-color-1-base

Define a custom primary color for the widget. Should provide good contrast with data-color-1-contrast.


Possible values

Any valid hex color code, e.g. #321de9

Value when omitted

 #321de9



data-color-1-contrast

Define a custom primary color for the widget. Should provide good contrast with data-color-1-base.


Possible values

Any valid hex color code, e.g. #321de9

Value when omitted

 #ffffff



data-color-2-base

Define a custom accent color for the widget. Should provide good contrast with data-color-2-contrast.


Possible values

Any valid hex color code, e.g. #321de9

Value when omitted

 #321d39



data-color-2-contrast

Define a custom accent color for the widget. Should provide good contrast with data-color-2-base.


Possible values

Any valid hex color code, e.g. #321de9

Value when omitted

 #fff



data-button-text

Define the text that is displayed on the widget button.


Possible values

Any alphanumeric text

Value when omitted

Depending on the user culture: "Book Now" / "Reserveren" / ...



data-positioning

Control where the widget appears on your website.


Possible values

Any valid data-positioning configuration

Value when omitted

[{ 'xAlign': 'right', 'xOffset': '2.6em', 'yOffset': '2.6em' }]



data-color-scheme

Configure the widget base color scheme.


Possible values

VisitorPreference, Light or Dark

Value when omitted

Light



Button appearance attributes


data-button-has-box-shadow

Configure whether a shadow appears behind the floating "Book now" widget button.


Possible values

true or false

Value when omitted

false


data-button-border-radius

Configure the border radius of the button.


Possible values

square, friendly, rounded, round, or any valid border-radius css value.

Value when omitted

round


data-button-has-border

Configure whether the button has a border.


Possible values

true or false

Value when omitted

false


data-button-border-color

Only used when `data-button-has-border="true"`. Configure the button border color.


Possible values

Any valid css color value.

Value when omitted

currentColor. This matches the current text color, as defined by `data-color-1-contrast`.



Content attributes


data-price-display

Configure the widget to display total prices or per person prices.


Possible values

PerPerson or Total

Value when omitted

Total



data-user-culture

Force the widget to display in a fixed culture (language, currency and date/time display format).


Possible values

Any valid culture code, specified as an IETF language tag.

Value when omitted

Culture specified by the browser of the visitor, or a suitable fallback.



data-start-of-week

Configure what day the calendar starts with.


Possible values

Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday

Value when omitted

Monday



Behavior attributes


data-auto-open

Automatically open the widget once it is loaded.


Possible values

true or false

Value when omitted

false


data-minimize-click-outside

Configure the behavior for when a visitor clicks outside the widget after interacting with it.


Possible values

true or false

Value when omitted

false



data-request-on-open

Force the visitor to enter information about their visit before they can view deals and products.


Possible values

People - forces the visitor to provide how many people are coming.
Date - forces the visitor to provide when they are planning to visit.
PeopleAndDate - forces the visitor to provide both how many people are coming and when they are planning to visit.
None - no information is required prior to viewing available deals and products.

Value when omitted

None



data-features

Configure specific non-standard behavior for the widget


Possible values

a comma-separated list of feature flags:

overviewPricingLabel [deprecated]- displays a label at the top of the list of deals and products in the widget, explaining the visitor how to interpret the displayed prices.

hideMainButton - prevents the widget button from being displayed. This is useful for pages that have deep links to the widget and do not want to use the floating button.

Value when omitted



data-browser-navigation

Allow browser back/forward buttons to control the widget screen history.


Possible values

Always, MobileOnly or Never

Value when omitted

MobileOnly



Default value attributes


data-default-visitors

Prefill the selected visitor group in the widget.


Possible values

A list of visitors, specified per segment. e.g. [['adult',2],['child',4]]

Value when omitted



data-default-date

Prefill the selected date in the widget


Possible values

Any date in the future, formatted as YYYY-mm-dd. e.g. 2026-01-24

Value when omitted



Data collection attributes


data-use-sentry

Allows the widget to automatically report widget related issues to Briq.


Possible values

true or false 

Value when omitted

true



data-use-ga

Allows the widget to automatically track pageviews and purchases via the datalayer for consumption by Google Tag Manager.


Possible values

false

Value when omitted

true



Advanced attributes


data-cdn-location

Configure the CDN endpoint URL.


Possible values

Any alphanumeric text

Value when omitted

Widget location



data-api-baseurl

Configure the Briq API endpoint URL.


Possible values

Any alphanumeric text

Value when omitted

Default API endpoint URL



data-keep-url

Will keep the url hash parameters in the browser address when opening the widget from a predefined URL. Allows for easy debugging.


Possible values

true or false

Value when omitted

false



data-url-param-source

Configure how parameters are passed to the widget from a URL


Possible values

Hash, Query, PreferHash, PreferQuery

Value when omitted

PreferHash

























Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article