Skip to content

ConsentSlotApi

type ConsentSlotApi = {
close: () => void;
decisions: Record<string, boolean>;
deny: (id) => void;
denyAll: () => void;
dismissNotice: () => void;
grant: (id) => void;
grantAll: () => void;
isGranted: (id) => boolean;
isOpen: boolean;
noticeOpen: boolean;
open: () => void;
ready: boolean;
reset: () => void;
resolved: ResolvedCategory[];
save: () => void;
storedAt: number | null;
};

Defined in: packages/vue/src/banner.ts:12

Shape passed to the <ConsentBanner> and <ConsentNotice> slot.

Different from ConsentApi (returned by useConsent()): the slot exposes a snapshot of plain values rather than ComputedRefs, since the slot is already re-invoked on every state change.

Type declaration

NameTypeDefined in
close() => voidpackages/vue/src/banner.ts:26
decisionsRecord<string, boolean>packages/vue/src/banner.ts:16
deny(id) => voidpackages/vue/src/banner.ts:20
denyAll() => voidpackages/vue/src/banner.ts:22
dismissNotice() => voidpackages/vue/src/banner.ts:27
grant(id) => voidpackages/vue/src/banner.ts:19
grantAll() => voidpackages/vue/src/banner.ts:21
isGranted(id) => booleanpackages/vue/src/banner.ts:28
isOpenbooleanpackages/vue/src/banner.ts:14
noticeOpenbooleanpackages/vue/src/banner.ts:15
open() => voidpackages/vue/src/banner.ts:25
readybooleanpackages/vue/src/banner.ts:13
reset() => voidpackages/vue/src/banner.ts:24
resolvedResolvedCategory[]packages/vue/src/banner.ts:17
save() => voidpackages/vue/src/banner.ts:23
storedAtnumber | nullpackages/vue/src/banner.ts:18