> For the complete documentation index, see [llms.txt](https://docs.carpose.de/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.carpose.de/readme.md).

# Carposé Components Documentation

Welcome to the developer documentation for **Carposé** embeddable components — the widgets that display vehicle inventory, offers, stores, and team members directly on your website.

## How integration works

Every component is added to your page with a single `<div>` carrying a `data-carpose-component` attribute and your API key. The library loads the component, renders it inside an isolated [Shadow DOM](/misc-modules/01_shadow-dom-architecture.md), and initialises it automatically.

First, load the integration script once:

```html
<script type="text/javascript" src="https://integration.carpose.app/integration.js"></script>
```

Then drop in any component:

```html
<div
  data-carpose-component="vehicle-search"
  data-api-key="your-api-key"
  data-search-url-forward="/search-results"
></div>
```

Refer to each component's page for its specific configuration options.

## Components

* [**Display & info components**](https://gitlab.com/carpose-de/dev-docs/-/blob/main/01_components/README.md) — image and 360° viewers, vehicle sliders, CO2 and consumption labels, wishlist, comparison, the budget calculator, and the floating-buttons overlay
* [**Vehicle search modules**](https://gitlab.com/carpose-de/dev-docs/-/blob/main/02_vehicle-search-modules/README.md) — the full search form, compact and AI search, the configurator, types browser, and vehicle groups
* [**Offer modules**](https://gitlab.com/carpose-de/dev-docs/-/blob/main/03_offer-modules/README.md) — promotional offer sliders and detail items
* [**Events**](https://gitlab.com/carpose-de/dev-docs/-/blob/main/04_events/README.md) — the DOM events components emit, with integration examples
* [**Misc modules**](https://gitlab.com/carpose-de/dev-docs/-/blob/main/05_misc-modules/README.md) — Shadow DOM architecture, static form values, stores, and employees

## Integrations

* [**React integration**](https://gitlab.com/carpose-de/dev-docs/-/blob/main/06_react-integration/README.md) — the standard script integration
* [**Wix integration**](https://gitlab.com/carpose-de/dev-docs/-/blob/main/08_wix-integration/README.md) — embedding the vehicle search on Wix via a Custom Element
* [**Model Context Protocol**](https://gitlab.com/carpose-de/dev-docs/-/blob/main/07_model-context-protocol/README.md) — exposing inventory data to AI assistants (experimental)