English en
Developers Blog
Search
Developers
JavaScript client

Constructor options

Every option accepted by new Entase(), with its default and its effect. All options are optional, and most can be overridden per booking.

View as Markdown

Every option is optional. The values below are the defaults the client applies when you leave one out.

JavaScript
const entase = new Entase({
  pk: null,
  locale: 'auto',
  checkoutMode: 'auto',
  collectConsent: true,
  backdrop: true,
  backdropColor: '#000000',
  tprm: {},
  pane:  { width: 800, height: '100%' },
  popup: { width: 800, height: 1000 }
});

Options

NameTypeDefaultDescription
pkstringnullYour publishable key. The client sends it when checking whether your domain is allowed to use inline checkout. Without it, every checkout opens as a pop-up.
localestring'auto'Language of the checkout. 'auto' reads the lang attribute of your <html> element.
checkoutModestring'auto''auto', 'pane' or 'popup'. See Checkout modes. An unrecognized value falls back to 'auto'.
collectConsentbooleantrueWhether the checkout asks the visitor to accept the terms notice. Once accepted, the answer is remembered in a cookie and the step is skipped.
backdropbooleantrueWhether to dim the page behind the checkout. false also disables the page scroll lock.
backdropColorstring'#000000'Colour of the dimmed area, as a CSS colour value.
tprmobject{}Tracking parameters appended to the checkout URL as query parameters. See Tracking and consent.
paneobject{ width: 800, height: '100%' }Size of the inline panel. Ignored in pop-up mode.
popupobject{ width: 800, height: 1000 }Size of the pop-up window, in pixels. Ignored in pane mode.

Pane and popup sizing

pane.width accepts a number (pixels) or any CSS length — '720px', '50%', '40vw', or a calc() expression. A plain number is treated as pixels.

The panel is capped at this width on desktop and takes the full width on mobile, where pane.height applies instead. The switch between the two happens when the viewport is narrower than the configured width; when the width is given as a relative unit, the switch happens at 800px.

popup.width and popup.height are pixel numbers only, and the window is centred on the visitor's screen. If the screen is not tall enough for the requested height, the window is reduced to fit.

Backdrop

The backdrop is dimmed more heavily behind a pop-up than behind a panel, because a pop-up needs the page underneath to read as inactive. Set backdrop: false to remove the dimming entirely — this also leaves the page scrollable behind the checkout.

backdropColor is applied as-is, so it can be any valid CSS colour. Use it to match a dark or branded site rather than to hide the backdrop; for that, backdrop: false is the correct option.

Per-booking overrides

checkoutMode, collectConsent, backdrop, backdropColor, pane and popup can all be overridden for a single booking by passing them to book(). The instance-level value stays unchanged for subsequent calls:

JavaScript
const entase = new Entase({ pk: 'YOUR_PUBLISHABLE_KEY' });

// This one booking opens wider, with no dimming.
entase.book('EVENT_ID', {
  pane: { width: '60vw' },
  backdrop: false
});

pk and tprm are not per-booking options — pk identifies the account for the whole page, and tracking parameters are changed with setTracking() when they need to differ.