All Public API methods are available on the CookieFirst object in the global namespace. It can also be accessed as a property of the window object.
javascript
const CF = CookieFirst;
// or
const CF = window.CookieFirst;
1. Cookie panel
1.1 Stealth mode
When in Stealth Mode, CookieFirst Banner doesn't render any consent-management interface. The only rendered content is the cookie declaration on a page supporting it. In Stealth Mode it's also impossible to programmatically control the cookie banner because you can't control something which doesn't exist.
To enable the stealth mode add data-stealth-mode to your banner script tag. The value of the attribute doesn't matter (can be set to true, false, or anything else). It's the fact it exists that enables the Stealth Mode.
<script
src="https://app.cookiefirst.com/loader/init.js"
data-cookiefirst-key="YOUR_API_KEY"
data-stealth-mode="true"
></script>
There are 2 methods allowing developers to open and close the Cookie Panel programmatically:
1. Open the panel. Opens the Cookie Panel if not currently open.
javascript
CookieFirst.openPanel();
2. Close the panel. Closes the Cookie Panel if it's open.
javascript
CookieFirst.closePanel();
2. Visitors consent
These methods and properties allow developers to retrieve visitor's current consent for a domain and programmatically trigger various actions which modify it.
If you're going to build an entire custom banner using this api you would need to hide our banner for now use the css below
.cookiefirst-root {
display: none;
}
1. Get info about visitor's consent
javascript
const consent = CookieFirst.consent;
// if consent is available, it will be an object of this structure:
{
necessary: true, // necessary category can't be disabled
performance: true|false,
functional: true|false,
advertising: true|false,
}
// otherwise it will be empty
consent === null; // true
2. withdrawConsent()
Consent withdraw function will clear the visitor's consent and log such change in our consent log. After this action is performed, website will reload to allow visitor's to have a fresh start on a domain. Banner will be shown again and no methods changing consent will be available until visitor consents again.
javascript
CookieFirst.withdrawConsent();
3. updateConsent()
This function allows developers to update visitor's consent and set it to a given value. It accepts a consent object as a parameter.
javascript
const newConsent = {...CookieFirst.consent};
newConsent.functional = true;
CookieFirst.updateConsent(newConsent);
4. acceptCategory()
This function allows you to perform basically the same action as above, but with one line of code.
javascript
CookieFirst.acceptCategory("functional");
5. acceptAllCategories()
This function allows you to consent to all available categories of cookies.
javascript
CookieFirst.acceptAllCategories();
6. acceptPreselectedCategories()
This function allows you to accept only the categories, which have been previously pre-selected in the domain settings screen in CookieFirst admin panel.
javascript
CookieFirst.acceptPreselectedCategories();
7. declineAllCategories()
This function allows you to accept only the necessary category and decline all other categories, with one line of code. Although it may seem similar to the withdrawConsent() function, it doesn't erase the consent completely and doesn't show the cookie banner. It updates the consent to have only the necessary cookies enabled.
javascript
CookieFirst.declineAllCategories();
8. declineCategory()
This function allows you to decline only one cookie category and preserve the rest of the consent as it was previously saved. (functional, advertising, performance)
javascript
CookieFirst.declineCategory("functional");