Skip to content

ConsentNoticeDefaultProps

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

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

Type declaration

NameTypeDescriptionDefined in
copy?Partial<NoticeCopy>Override individual labels. Layered on top of the resolved locale.packages/banner-default/src/react/notice.tsx:16
locale?stringBCP-47 language tag ('en', 'de', …) or 'auto'. See ConsentBannerDefault for the built-in list.packages/banner-default/src/react/notice.tsx:12
optOutCategoryId?stringCategory 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:23
policyUrl?stringPrivacy-policy URL. If omitted, the link is hidden.packages/banner-default/src/react/notice.tsx:18
theme?"light" | "dark"Force light or dark theme.packages/banner-default/src/react/notice.tsx:25