Config reference
Everything is set on the init() config, or centrally per-site in the dashboard
(dashboard config is merged over init()). Only siteId is required, and
the license key usually supplies it.
Core options
Section titled “Core options”| Option | Type | Default | Notes |
|---|---|---|---|
siteId |
string |
— | Usually supplied by the license key. |
key |
string |
— | License key; normally baked into the script URL. |
apiBase |
string |
hosted edge | Base URL of the Lightning Worker. |
theme |
name or tokens | "light" |
Appearance. Tokens take an optional base ("auto"/"light"/"dark"). |
privacyPolicyUrl |
string |
— | Shows a privacy-policy link in the modal. Appearance. |
categories |
CategoryId[] |
all four | Categories. |
position |
BannerPosition |
"bottom" |
Banner anchor. |
showFloatingButton |
boolean |
true |
Persistent re-open button. |
floatingButtonPosition |
FabPosition |
"bottom-left" |
FAB anchor. |
geo |
"auto" or regulation |
"auto" |
Regulations. |
googleConsentMode |
boolean |
true |
Consent Mode. |
bridges |
BridgeConfig |
— | Bridges. |
respectGpc |
boolean |
true |
Honour Global Privacy Control. |
experiment |
boolean |
false |
A/B testing. |
consentExpiryDays |
number |
0 (never) |
Re-prompt after N days. |
locale |
string |
document lang | BCP-47 locale. |
copyStarter |
CopyStarter |
"professional" |
Base copy for the banner and preferences modal. text overrides it. |
text |
CmpText |
— | Copy overrides. |
hideBranding |
boolean |
false |
White-label. |
debug |
boolean |
false |
Debug logging. |
onReady |
(state) => void |
— | Fires once init completes. |
onConsentChange |
(state) => void |
— | Fires on every change incl. initial load. |
Enum values
Section titled “Enum values”CategoryId—necessary|preferences|statistics|marketing.BannerPosition—bottom|top|bottom-left|bottom-right.FabPosition—bottom-left|bottom-right|top-left|top-right.CopyStarter—professional|clear|friendly|concise.- Regulation —
gdpr|ccpa|none.