ConsentNoticeDefaultProps

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

Defined in: packages/banner-default/src/react/notice.tsx:14

Type declaration

Name	Type	Description	Defined in
branding?	boolean	When true, adds a small “Powered by Tickbox” link to tickbox.dev under the notice. Off by default — see ConsentBannerDefault.branding for the reasoning.	packages/banner-default/src/react/notice.tsx:46
cloudEndpoint?	string	Defaults to https://api.tickbox.dev. Override only for self-hosting.	packages/banner-default/src/react/notice.tsx:40
copy?	Partial<NoticeCopy>	Override individual labels. Layered on top of the resolved locale.	packages/banner-default/src/react/notice.tsx:23
locale?	string	BCP-47 language tag ('en', 'de', …) or 'auto'. See ConsentBannerDefault for the built-in list.	packages/banner-default/src/react/notice.tsx:19
optOutCategoryId?	string	Category ID to deny when the user clicks “Opt out”. Defaults to 'analytics' since that’s the most common notice-mode category.	packages/banner-default/src/react/notice.tsx:30
policyUrl?	string	Privacy-policy URL. If omitted, the link is hidden.	packages/banner-default/src/react/notice.tsx:25
siteId?	string	Site identifier from app.tickbox.dev. When set, the notice fetches its remote presentation theme (copy + colours) on mount the same way the banner does, so marketing-team-edited copy lands without a redeploy.	packages/banner-default/src/react/notice.tsx:38
theme?	"light" | "dark"	Force light or dark theme.	packages/banner-default/src/react/notice.tsx:32