Skip to content

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/vue/notice.ts:15

Type declaration

NameTypeDescriptionDefined in
branding?booleanWhen true, adds a small “Powered by Tickbox” link to tickbox.dev under the notice. Off by default; local-only setting.packages/banner-default/src/vue/notice.ts:33
cloudEndpoint?stringDefaults to https://api.tickbox.dev. Override only for self-hosting.packages/banner-default/src/vue/notice.ts:28
copy?Partial<NoticeCopy>-packages/banner-default/src/vue/notice.ts:17
locale?string-packages/banner-default/src/vue/notice.ts:16
optOutCategoryId?string-packages/banner-default/src/vue/notice.ts:19
policyUrl?string-packages/banner-default/src/vue/notice.ts:18
siteId?stringSite identifier from app.tickbox.dev. When set, the notice fetches its remote presentation theme (copy + colours) on mount — same plumbing the banner uses.packages/banner-default/src/vue/notice.ts:26
theme?"light" | "dark"-packages/banner-default/src/vue/notice.ts:20