You are currently viewing documentation for Cookie Control Premium. View the documentation for Cookie Control v9.
API Reference
On this page
Cookie Control Premium exposes a lightweight JavaScript API under the window.CookieControl namespace. This lets you react to consent changes and integrate premium behaviour with your own scripts and analytics tools.
Anchor link for onConsentChange
window.CookieControl.onConsentChange(category, handlers) registers callbacks that fire when a user accepts or revokes consent for a given category. Use this to trigger custom behaviour — such as initialising an analytics library or clearing stored tracking data — in response to the user's consent decision.
Anchor link for Parameters
- category string
- The consent category to listen to. Must match a category name configured in your allow list (e.g. analytics, marketing, preferences).
- handlers object
- An object containing one or both of the following callback functions:
- onAccept () => void
- Called when the user accepts consent for this category, or if consent was already accepted when the handler is registered.
- onRevoke () => void
- Called when the user revokes consent for this category.
Anchor link for Examples
Basic usage
window.CookieControl.onConsentChange('analytics', {
onAccept: () => {
console.log('User Handler - accept analytics');
},
onRevoke: () => {
console.log('User Handler - revoke analytics');
}
});Listening to multiple categories
window.CookieControl.onConsentChange('analytics', {
onAccept: () => { console.log('User Handler - accept analytics'); },
onRevoke: () => { console.log('User Handler - revoke analytics'); }
});
window.CookieControl.onConsentChange('marketing', {
onAccept: () => { console.log('User Handler - accept marketing'); },
onRevoke: () => { console.log('User Handler - revoke marketing'); }
});