# Bookzo Elements

> Bookzo Elements is a booking engine for accommodation rental (hotels, B&Bs, campings, holiday
> parks, chalets), delivered as HTML custom elements. Load one script, place tags like
> `<bookzo-home>` on a page, and configure them with a JSON string in the `config` attribute plus a
> few global JavaScript variables. No build step and no framework required — plain HTML, WordPress
> or any CMS works.

The interactive configurator at https://configurator.bookzo.nl is the source of truth, but it is a
client-side application: fetching its URLs returns an empty HTML shell. The files below are a
plain-text mirror of the same documentation, written for automated readers.

Quick start:

```html
<script src="https://cdn.bookzoapi.nl/bookzo-elements/bookzo-elements.js" async defer></script>
<bookzo-search></bookzo-search>
<bookzo-home apikey='YOUR_API_KEY'></bookzo-home>
```

Three hard requirements: the page must be served over **https** (on `https://localhost` every key
works, including `test`); the API key is bound to the domain it was registered for; and `config` is
a JSON string in single quotes containing only values that differ from the default.

## Docs

- [Start here](/skill/docs/00-start-here.md): what Bookzo Elements is, the workflow for building or
  changing a Bookzo site, and the mistakes that cost the most time.
- [Elements](/skill/docs/elements.md): all 15 element tags, their attributes, and which config
  sections apply to each.
- [Config reference](/skill/docs/config-reference.md): every config key with its default, type and
  the exact string values of every enum.
- [Global configuration](/skill/docs/global-config.md): the activation script, CSP requirements, the
  `bookzoElements*` global variables, and how to request an API key.
- [Multi page setup](/skill/docs/multi-page.md): splitting the flow over several URLs, and the
  pattern for JavaScript frameworks and single-page apps.
- [The Bookzo API](/skill/docs/api.md): which accommodations exist — ids for the multi page
  `objectUrlMap`, and the titles, descriptions, images and SEO fields for generated pages. Includes
  the two generator scripts.
- [Events](/skill/docs/events.md): the ten DOM events with their full payloads, plus conversion
  tracking with Google Analytics.
- [URL parameters](/skill/docs/url-parameters.md): deep links that pre-fill a search, and prefilter
  links for campaign and promotion pages.
- [Styling](/skill/docs/styling.md): how the CSS is scoped, overriding Bookzo's styling, button
  variants, and preventing layout shift.
- [Rendered HTML](/skill/docs/rendered-html.md): the actual DOM the elements output, the stable CSS
  hooks and element ids, and how config changes affect the markup.
- [Booking form](/skill/docs/booking-form.md): hidden and extra fields, custom inputs, own
  validation, and login for returning guests.
- [Languages](/skill/docs/languages.md): supported languages, how the language is chosen, and the
  full list of overridable texts.

## Optional

- [Everything in one file](/skill/llms-full.txt): the whole documentation set concatenated, for
  readers that prefer a single fetch.
- [Agent Skill download](/skill/bookzo-elements.skill): the same documentation packaged as a Claude
  Agent Skill. See [installation instructions](/skill/).
- [Configurator](https://configurator.bookzo.nl): the interactive version, with a live preview per
  element. Requires a browser that runs JavaScript.
- [Bookzo support](https://support.bookzo.nl): API keys, review-form e-mail templates and account
  questions.