ConsentBannerDefaultProps

type ConsentBannerDefaultProps = {
  branding: boolean;
  cloudEndpoint: string;
  copy: Partial<BannerCopy>;
  locale: string;
  policyUrl: string;
  siteId: string;
  theme: "light" | "dark";
};

Defined in: packages/banner-default/src/vue/banner.ts:15

Type declaration

Name	Type	Description	Defined in
branding?	boolean	When true, adds a small “Powered by Tickbox” link to tickbox.dev under the banner. Off by default; local-only setting.	packages/banner-default/src/vue/banner.ts:39
cloudEndpoint?	string	Defaults to https://api.tickbox.dev. Override only for self-hosting.	packages/banner-default/src/vue/banner.ts:34
copy?	Partial<BannerCopy>	-	packages/banner-default/src/vue/banner.ts:22
locale?	string	BCP-47 language tag ('en', 'de', 'fr-CH', …) or 'auto'. Built-in: en, de, fr, es, it, nl, pt, pl, uk. Falls back from the full tag to the language prefix, then to English.	packages/banner-default/src/vue/banner.ts:21
policyUrl?	string	-	packages/banner-default/src/vue/banner.ts:23
siteId?	string	Site identifier from app.tickbox.dev. When set, the banner fetches its remote presentation theme (copy + colours) on mount from cloudEndpoint/v1/theme/{siteId} and applies it on top of copy. Last fetched theme is cached in localStorage so the next page load renders synchronously with no flicker.	packages/banner-default/src/vue/banner.ts:32
theme?	"light" | "dark"	-	packages/banner-default/src/vue/banner.ts:24