Update readme

Signed-off-by: Émile Ré <emile@getprobo.com>
This commit is contained in:
Émile Ré
2026-04-27 09:45:31 +04:00
parent 79c17ad3a0
commit e4ae05c133

View File

@@ -1,28 +1,102 @@
# @probo/cookie-banner
A lightweight, GDPR-compliant cookie consent banner for the web. Works with any framework or plain HTML — zero dependencies, powered by Web Components.
A lightweight, dependency-free cookie consent banner built on Web Components. Bundle it with your app as an ES module, use it headless with full UI control, or drop it in with a single script tag. Works with any framework or plain HTML.
Supports opt-in (GDPR, ePrivacy) and opt-out (CCPA/CPRA) consent modes, per-category cookie controls, third-party resource blocking, Google Consent Mode v2, PostHog integration, and multi-language support out of the box.
## Installation
There are three ways to use the SDK:
### Script Tag (IIFE)
No bundler required — add a single `<script>` tag:
```html
<script
src="https://cdn.jsdelivr.net/npm/@probo/cookie-banner/dist/cookie-banner.iife.js"
data-banner-id="YOUR_BANNER_ID"
data-base-url="https://your-probo-instance.com/api/cookie-banner/v1/"
data-position="bottom-left"
></script>
```
This renders a fully styled consent dialog and a floating settings button automatically.
### ES Module (Themed Banner)
For bundled applications (React, Vue, Svelte, Next.js, etc.):
```bash
npm install @probo/cookie-banner
```
Or drop a single `<script>` tag — no bundler required:
```js
import { registerThemedBanner } from "@probo/cookie-banner";
registerThemedBanner();
```
```html
<script
src="https://unpkg.com/@probo/cookie-banner/dist/cookie-banner.iife.js"
data-banner-id="YOUR_BANNER_ID"
data-base-url="BASE_URL"
></script>
<probo-cookie-banner
banner-id="YOUR_BANNER_ID"
base-url="https://your-probo-instance.com/api/cookie-banner/v1/"
position="bottom-left"
></probo-cookie-banner>
```
See [Theming](https://www.getprobo.com/docs/product/cookie-banner/theming) to customize colors, fonts, and styling with CSS custom properties.
### Headless Components
For complete control over the consent UI, use the unstyled Web Component building blocks:
```js
import { registerComponents } from "@probo/cookie-banner/headless";
registerComponents();
```
```html
<probo-cookie-banner-root banner-id="YOUR_BANNER_ID" base-url="BASE_URL">
<probo-banner>
<div class="my-banner">
<p>We use cookies to improve your experience.</p>
<probo-accept-button><button>Accept all</button></probo-accept-button>
<probo-reject-button><button>Reject all</button></probo-reject-button>
<probo-customize-button><button>Customize</button></probo-customize-button>
</div>
</probo-banner>
<probo-preference-panel>
<div class="my-preferences">
<probo-category-list>
<template>
<div class="category">
<span data-slot="name"></span>
<span data-slot="description"></span>
<probo-category-toggle><input type="checkbox" /></probo-category-toggle>
</div>
</template>
</probo-category-list>
<probo-save-button><button>Save preferences</button></probo-save-button>
</div>
</probo-preference-panel>
</probo-cookie-banner-root>
```
## Key Features
- **Multi-regulation compliance** — Supports opt-in (GDPR, ePrivacy) and opt-out (CCPA/CPRA) consent modes, Global Privacy Control (GPC) detection, and per-category cookie controls.
- **Consent audit trail** — Every consent action is recorded server-side with anonymized IP, user agent, per-category choices, and a reference to the exact banner version the visitor saw.
- **Third-party blocking** — Automatically prevents scripts, iframes, images, and other resources from loading until the visitor grants consent for the matching category.
- **Built-in integrations** — Syncs consent state with Google Consent Mode v2 and PostHog automatically.
- **Multi-language support** — Built-in translations for English, French, German, and Spanish. The SDK auto-detects the visitor's language from the page or browser.
- **Theming** — Match your brand with CSS custom properties for colors, fonts, border radius, and more. Supports dark mode.
## Documentation
Full documentation — including theming, headless components, and script blocking — is available at:
**https://www.getprobo.com/docs/product/cookie-banner/overview**
Full documentation is available at **https://www.getprobo.com/docs/product/cookie-banner/overview**
## License