Lightweight Cookie Notice JS

Table of Contents

  1. Installation
  2. Examples
  3. Status
  4. Clear the Preferences
  5. Options

1) Installation

You can complete the installation of Lightweight Cookie Notice JS in three simple steps:

Add the Open Sans font

The default font used in the cookie notice is the bold variation of the Open Sans font. To embed this font in your webpage, copy this code in the <head> of your HTML document:

<link href="https://fonts.googleapis.com/css?family=Open+Sans:400,600" rel="stylesheet">

You can skip this step if you are planning to use a different font family. More information on how to change the font family are available in the Options section.

Load the JavaScript file

Add this <script> tag in the <head> section of the webpage:

<script src="js/lwcnCookieNotice.js"></script>

You can find the production version o Lightweight Cookie Notice JS in the lightweight-cookie-notice/production/js/ folder. The development version is available in the lightweight-cookie-notice/development/js/ folder.

Initialize the cookie notice

Add this code at the end of the <head> section of the webpage:

<script>
lwcnCookieNotice.initialize();
</script>

Please note that Lightweight Cookie Notice JS comes with 100 customization options. Visit the Options section for more details.

2) Examples

In this section, you can find multiple implementation examples:

Example 1

This example applies the following customizations:

  • Custom text for the cookie notice main message
  • Button 1 disabled
  • Custom text for button 2

The initialization code:

lwcnCookieNotice.initialize({
  cookieNoticeMainMessageText: 'By clicking “Accept all cookies”, you agree that our website can store cookies on your device and disclose information in accordance with our <a href="https://example.com/cookie-policy/">Cookie Policy</a>.',
  cookieNoticeButton1Action: '0',
  cookieNoticeButton2Text: 'Accept all cookies',
});

Example 2

This example applies the following customizations:

  • Custom text for button 1
  • Custom text for the cookie settings description header

The initialization code:

lwcnCookieNotice.initialize({
  cookieNoticeButton1Text: 'Cookies Policy',
  cookieSettingsDescriptionHeader: '<p>Last updated: September 16, 2020</p><p>This Cookies Policy explains what Cookies are and how We use them. You should read this policy so You can understand what type of cookies We use, or the information We collect using Cookies and how that information is used.</p><p>Cookies do not typically contain any information that personally identifies a user, but personal information that we store about You may be linked to the information stored in and obtained from Cookies. For further information on how We use, store and keep your personal data secure, see our Privacy Policy.</p><p>We do not store sensitive personal information, such as mailing addresses, account passwords, etc. in the Cookies We use.</p><p><strong>Type of cookies we use</strong></p><p>Cookies can be \u201cPersistent\u201d or \u201cSession\u201d Cookies. Persistent Cookies remain on your personal computer or mobile device when You go offline, while Session Cookies are deleted as soon as You close your web browser.</p><p>We use both session and persistent Cookies for the purposes set out below:</p><ul><li>Necessary / Essential Cookies Type: Session Cookies Administered by: Us Purpose: These Cookies are essential to provide You with services available through the Website and to enable You to use some of its features. They help to authenticate users and prevent fraudulent use of user accounts. Without these Cookies, the services that You have asked for cannot be provided, and We only use these Cookies to provide You with those services.</li><li>Functionality Cookies Type: Persistent Cookies Administered by: Us Purpose: These Cookies allow us to remember choices You make when You use the Website, such as remembering your login details or language preference. The purpose of these Cookies is to provide You with a more personal experience and to avoid You having to re-enter your preferences every time You use the Website.</li></ul><p><strong>Your choises regarding cookies</strong></p><p>If You prefer to avoid the use of Cookies on the Website, first You must disable the use of Cookies in your browser and then delete the Cookies saved in your browser associated with this website. You may use this option for preventing the use of Cookies at any time.</p><p>If You do not accept Our Cookies, You may experience some inconvenience in your use of the Website and some features may not function properly.</p><p>If You\u2019d like to delete Cookies or instruct your web browser to delete or refuse Cookies, please visit the help pages of your web browser.</p><ul><li>For the Chrome web browser, please visit this page from Google: <a href="https://support.google.com/accounts/answer/32050">https://support.google.com/accounts/answer/32050</a></li><li>For the Internet Explorer web browser, please visit this page from Microsoft: <a href="http://support.microsoft.com/kb/278835">http://support.microsoft.com/kb/278835</a></li><li>For the Firefox web browser, please visit this page from Mozilla: <a href="https://support.mozilla.org/en-US/kb/delete-cookies-remove-info-websites-stored">https://support.mozilla.org/en-US/kb/delete-cookies-remove-info-websites-stored</a></li><li>For the Safari web browser, please visit this page from Apple: <a href="https://support.apple.com/guide/safari/manage-cookies-and-website-data-sfri11471/mac">https://support.apple.com/guide/safari/manage-cookies-and-website-data-sfri11471/mac</a></li></ul><p>For any other web browser, please visit your web browser\u2019s official web pages.</p><p><strong>Contact us</strong></p><p>If you have any questions about this Cookies Policy, You can contact us:</p><ul><li>By email: <a href="mailto:support@example.com">support@example.com</a></li></ul>',
});

Example 3

In this example, two sections and five cookie categories (three in the first section and two in the second section) are defined.

The initialization code:

lwcnCookieNotice.initialize({
  sections: [
    {
      'sectionId': 1,
      'name': 'Basic ads, personalized content, and ad measurement',
      'description': 'Basic ads can be served. Content can be personalized based on a profile. More data can be added to better personalize content. Ad performance can be measured.',
      'categories': [
        {
          'categoryId': 1,
          'name': 'Select personalized content',
          'description': '<p>To select personalized content vendors can:</p><ul><li>Select personalized content based on a user profile or other historical user data, including a useru2019s prior activity, interests, visits to sites or apps, location, or demographic information.</li></ul>',
          'toggle': true,
          'defaultStatus': true,
          'priority': 0,
          'cookies': [],
        }, {
          'categoryId': 2,
          'name': 'Select basic ads',
          'description': '<p>To do basic ad selection vendors can:</p>n<ul>n<li>Use real-time information about the context in which the ad will be shown, to show the ad, including information about the content and the device, such as: device type and capabilities, user agent, URL, IP address</li>n<li>Use a useru2019s non-precise geolocation data</li>n<li>Control the frequency of ads shown to a user.</li>n<li>Sequence the order in which ads are shown to a user.</li>n<li>Prevent an ad from serving in an unsuitable editorial (brand-unsafe) context</li>n</ul>nn<p>Vendors cannot:</p>n<ul>n<li>Create a personalized ads profile using this information for the selection of future ads without a separate legal basis to create a personalized ads profile.</li>n<li>N.B. Non-precise means only an approximate location involving at least a radius of 500 meters is permitted.</li>n</ul>',
          'toggle': true,
          'defaultStatus': true,
          'priority': 0,
          'cookies': [],
        }, {
          'categoryId': 3,
          'name': 'Measure ad performance',
          'description': '<p>To measure ad performance vendors can:</p>n<ul>n<li>Measure whether and how ads were delivered to and interacted with by a user</li>n<li>Provide reporting about ads including their effectiveness and performance</li><li>Provide reporting about users who interacted with ads using data observed during the course of the user\'s interaction with that ad</li>n<li>Provide reporting to publishers about the ads displayed on their property</li>n<li>Measure whether an ad is serving in a suitable editorial environment (brand-safe) contextn<li>Determine the percentage of the ad that had the opportunity to be seen and the duration of that opportunity</li>n<li>Combine this information with other information previously collected, including from across websites and apps</li>n</ul>n<p>Vendors cannot:</p>n<ul>n<li>Apply panel- or similarly-derived audience insights data to ad measurement data without a Legal Basis to apply market research to generate audience insights (Purpose 9)</li></ul>',
          'toggle': true,
          'defaultStatus': true,
          'priority': 0,
          'cookies': [],
        },
      ],
    },
    {
      'sectionId': 2,
      'name': 'Personalized ads profile and display',
      'description': 'Ads can be personalized based on a profile. More data can be added to better personalize ads.',
      'categories': [
        {
          'categoryId': 4,
          'name': 'Select personalized ads',
          'description': '<p>To select personalized ads vendors can:</p>n<ul>n<li>Select personalized ads based on a user profile or other historical user data, including a useru2019s prior activity, interests, visits to sites or apps, location, or demographic information.</li>n</ul>',
          'toggle': true,
          'defaultStatus': true,
          'priority': 0,
          'cookies': [],
        },
        {
          'categoryId': 5,
          'name': 'Create a personalized ads profile',
          'description': '<p>To create a personalized ads profile vendors can:</p>n<ul>n<li>Collect information about a user, including a user\'s activity, interests, demographic information, or location, to create or edit a user profile for use in personalized advertising.</li>n<li>Combine this information with other information previously collected, including from across websites and apps, to create or edit a user profile for use in personalized advertising.n</li>n</ul>',
          'toggle': true,
          'defaultStatus': true,
          'priority': 0,
          'cookies': [],
        }],
    }],
});

Example 4

In this example, the cookie notice is displayed only to the users located in European countries. The HostIP.info geolocation service is used.

The ready-to-use code:

lwcnCookieNotice.initialize({
  enableGeolocation: true,
  geolocationService: 0,
  geolocationLocale: ['at', 'au', 'be', 'bg', 'cy', 'cz', 'dk', 'ee','es', 'fi', 'fr', 'gb', 'hu', 'ie', 'it', 'lt', 'lu', 'lv', 'mt', 'nl', 'pl', 'pt', 'se', 'sg', 'si', 'sk'],
});

Example 5

In this example, the cookie notice is displayed only to the users located in European countries. The GeoLite2 IP geolocation service, provided by MaxMind, is used.

The initialization code:

lwcnCookieNotice.initialize({
  enableGeolocation: true,
  geolocationService: 1,
  geolocationLocale: ['at', 'au', 'be', 'bg', 'cy', 'cz', 'dk', 'ee','es', 'fi', 'fr', 'gb', 'hu', 'ie', 'it', 'lt', 'lu', 'lv', 'mt', 'nl', 'pl', 'pt', 'se', 'sg', 'si', 'sk'],
});

Please note that to use this geolocation service, you have to:

  1. Download the GeoLite2 database from the MaxMind website and place it in the lightweight-cookie-notice-js/geolocation/database/ folder.
  2. Set the name of the database file with the GEOLITE2_DATABASE_FILE_PATH constant available in the lightweight-cookie-notice-js/geolocation/config.php file.

Example 6

In this example, the cookie notice is displayed as a modal window placed in the center of the screen.

The initialization code:

lwcnCookieNotice.initialize({
  cookieNoticeContainerPosition: 1
});

Example 7

In this example, the following customizations are applied:

  • A custom background color has been assigned to the cookie notice
  • A custom color for the main cookie notice message has been assigned
  • Button 1 disabled
  • Custom style for the second button

The initialization code:

lwcnCookieNotice.initialize({
  cookieNoticeMainMessageFontColor: '#ffffff',
  cookieNoticeMainMessageLinkFontColor: '#1e58b1',
  cookieNoticeButton1Action: 0,
  cookieNoticeButton2BackgroundColor: '#1e58b1',
  cookieNoticeButton2BackgroundColorHover: '#1e58b1',
  cookieNoticeButton2BorderColor: '#ffffff',
  cookieNoticeButton2BorderColorHover: '#ffffff',
  cookieNoticeButton2FontColor: '#ffffff',
  cookieNoticeButton2FontColorHover: '#ffffff',
  cookieNoticeContainerBackgroundColor: '#1e58b1',
});

Example 8

In this example, one section and two cookie categories are defined. The first category includes a list of five cookies. The second section includes a list of three cookies.

The initialization code:

lwcnCookieNotice.initialize({
  cookieTableColumns: ['name', 'expiration', 'purpose'],
  sections: [
    {
      'sectionId': 1,
      'name': 'Ecommerce Cookies',
      'description': 'Details on our use of cookies are provided in tables below, listing various cookies that are set for the users of the store.rn',
      'categories': [
        {
          'categoryId': 1,
          'name': 'Store Front End',
          'description': 'These cookies are used in the front end of our website.',
          'toggle': true,
          'defaultStatus': true,
          'priority': 0,
          'cookies': [
            {
              'provider': '',
              'domain': '',
              'name': 'ecommerce_cart_hash',
              'purpose': 'Helps the ecommerce determine when cart contents/data changes.',
              'expiration': 'session',
              'type': '',
              'sensitivity': '',
              'security': '',
              'priority': 0,
            },
            {
              'provider': '',
              'domain': '',
              'name': 'ecommerce_items_in_cart',
              'purpose': 'Helps ecommerce determine when cart contents/data changes.',
              'expiration': 'session',
              'type': '',
              'sensitivity': '',
              'security': '',
              'priority': 0,
            },
            {
              'provider': '',
              'domain': '',
              'name': 'wp_ecommerce_session_',
              'purpose': 'Contains a unique code for each customer so that it knows where to find the cart data in the database.',
              'expiration': '2 days',
              'type': '',
              'sensitivity': '',
              'security': '',
              'priority': 0,
            },
            {
              'provider': '',
              'domain': '',
              'name': 'recently_viewed',
              'purpose': 'Powers the Recent Viewed Products widget.',
              'expiration': 'session',
              'type': '',
              'sensitivity': '',
              'security': '',
              'categoryId': 27,
              'priority': 0,
            },
            {
              'provider': '',
              'domain': '',
              'name': 'store_notice',
              'purpose': 'Allows customers to dismiss the Store Notice.',
              'expiration': 'session',
              'type': '',
              'sensitivity': '',
              'security': '',
              'priority': 0,
            }],
        },
        {
          'categoryId': 2,
          'name': 'Store Dashboard',
          'description': 'These cookies are used in the back end of WordPress. No personal information is stored within these cookies.',
          'toggle': '1',
          'defaultStatus': '1',
          'priority': 0,
          'cookies': [
            {
              'provider': '',
              'domain': '',
              'name': 'snooze_suggestions',
              'purpose': 'Allows dashboard users to dismiss Marketplace suggestions, if enabled.',
              'expiration': '2 days',
              'type': '',
              'sensitivity': '',
              'security': '',
              'priority': 0,
            },
            {
              'provider': '',
              'domain': '',
              'name': 'dismissed_suggestions',
              'purpose': 'Count of suggestion dismissals, if enabled.',
              'expiration': '1 month',
              'type': '',
              'sensitivity': '',
              'security': '',
              'priority': 0,
            },
            {
              'provider': '',
              'domain': '',
              'name': 'tk_ai',
              'purpose': 'Stores a randomly generated anonymous ID. This is only used within the dashboard (/wp-admin) area an',
              'expiration': 'session',
              'type': '',
              'sensitivity': '',
              'security': '',
              'priority': 0,
            }],
        }],
    }],
});

3) Status

At any time, you can retrieve the status of the cookie notice in the front-end with JavaScript or in the back-end with PHP.

JavaScript

lwcnUtility.getCookiesData()

Return

An object with the accepted and categories properties is returned.

The accepted property includes the general state of the cookie notice (true if the cookie notice has been accepted and false if the cookie notice has not been accepted).

The categories property includes an object with the category IDs as property names. The value of each property is a Boolean that indicates the state of the related category. (true if the cookie category has been accepted or false if the cookie category has not been accepted). If the cookie categories are not used, this property has an empty array as a value.

This is the example of a response generated when a cookie notice has not been accepted and the cookie categories are not used.

{
  accepted: false,
  categories: []
}

This is the example of a response generated when a cookie notice has been accepted, and the cookie categories are not used.

{
  accepted: true,
  categories: []
}

This is the example of a response generated when a cookie notice has been accepted, and two cookie categories are present and accepted.

{
  accepted: true,
  categories: {
    1: true
    2: true
  }
}

PHP

require_once( 'include/class-lwcn-utility.php' );
$cookie_data = Lwcn_Utility::get_cookies_data();

Return

An associative array with the accepted and categories indexes is returned.

The accepted index includes the general state of the cookie notice (true if the cookie notice has been accepted and false if the cookie notice has not been accepted).

The categories index includes an array with the category IDs as indexes. The value of each index is a Boolean that indicates the state of the related category. (true if the cookie category has been accepted or false if the cookie category has not been accepted). If the cookie categories are not used, this property has an empty array as a value.

This is the example of a response generated when a cookie notice has not been accepted, and the cookie categories are not used.

[
  'accepted' => false,
  'categories' => []
]

This is the example of a response generated when a cookie notice has been accepted, and the cookie categories are not used.

[
  'accepted' => true,
  'categories' => []
]

This is the example of a response generated when a cookie notice has been accepted, and two cookie categories are present and accepted.

[
  'accepted' => true,
  'categories' => [
    '1' => true,
    '2' => true
  ]
]

4) Clear the preferences

You can clear the user preferences with JavaScript or PHP:

JavaScript

Use this method to clear the cookie preference of the user without refreshing the page:

lwcnUtility.clearPreferences();

Set the first parameter of the method to true to clear the preferences of the user and refresh the page:

lwcnUtility.clearPreferences(true);

PHP

Use this static method to clear the cookie preference of the user without refreshing the page:

require_once( 'include/class-lwcn-utility.php' );
Lwcn_Utility::clear_preferences();

Note that you should use this method before sending any output.

5) Options

This product has a total of 100 customization options. To use a customization option, set its value during the initialization process of the news ticker.

Use this table to understand how each option should be used:

NameTypeDefaultDescription
headingsFontFamilystring'\'Open Sans\', Helvetica, Arial, sans-serif'The font family of the headings.
headingsFontWeightnumber600The font weight of the headings.
paragraphsFontFamilystring'\'Open Sans\', Helvetica, Arial, sans-serif'The font family of the paragraphs.
paragraphsFontWeightnumber400The font weight of the paragraphs.
strongTagsFontWeightnumber600The font weight of the strong tags.
buttonsFontFamilystring'\'Open Sans\', Helvetica, Arial, sans-serif'The font family of the buttons.
buttonsFontWeightnumber400The font weight of the buttons.
buttonsBorderRadiusnumber4The border radius of the buttons.
containersBorderRadiusnumber4The border radius of the containers.
cookieNoticeMainMessageTextstringCustom HTMLThe text of the message displayed in the cookie notice.
cookieNoticeMainMessageFontColorstring'#666666'The font color of the message displayed in the cookie notice.
cookieNoticeMainMessageLinkFontColorstring'#1e58b1'The font color of the links included in the message displayed in the cookie notice.
cookieNoticeButton1Textstring'settings'The text of the button 1 of the cookie notice.
cookieNoticeButton1Actionstring1The action performed after clicking the button 1 of the cookie notice. The possible values are: ‘0’ (Disabled), ‘1’ (Cookie Settings), ‘2’ (Accept Cookies), ‘3’ (Close Cookie Notice), ‘4’ (Redirect to URL)
cookieNoticeButton1Urlstring''The URL where the user will be redirected after clicking the button 1 of the cookie notice.
cookieNoticeButton1BackgroundColorstring'#ffffff'The background color of the button 1 of the cookie notice.
cookieNoticeButton1BackgroundColorHoverstring'#ffffff'The background color of the button 1 in hover state of the cookie notice.
cookieNoticeButton1BorderColorstring'#1e58b1'The border color of the button 1 of the cookie notice.
cookieNoticeButton1BorderColorHoverstring'#1e58b1'the border color of the button 1 in hover state of the cookie notice.
cookieNoticeButton1FontColorstring'#1e58b1'The font color of the button 1 of the cookie notice.
cookieNoticeButton1FontColorHoverstring'#1e58b1'The font color of the button 1 in hover state of the cookie notice.
cookieNoticeButton2Textstring'Accept'The text of the button 2 of the cookie notice..
cookieNoticeButton2Actionnumber2The action performed after clicking the button 2 of the cookie notice. The possible values are: ‘0’ (Disabled), ‘1’ (Cookie Settings), ‘2’ (Accept Cookies), ‘3’ (Close Cookie Notice), ‘4’ (Redirect to URL)
cookieNoticeButton2Urlstring''The URL where the user will be redirected after clicking the button 2 of the cookie notice.
cookieNoticeButton2BackgroundColorstring'#1e58b1'The background color of the button 2 of the cookie notice.
cookieNoticeButton2BackgroundColorHoverstring'#1e58b1'The background color of the button 2 in hover state of the cookie notice.
cookieNoticeButton2BorderColorstring'#1e58b1'The border color of the button 2 of the cookie notice.
cookieNoticeButton2BorderColorHoverstring'#1e58b1'The border color of the button 2 in hover state of the cookie notice.
cookieNoticeButton2FontColorstring'#ffffff'The font color of the button 2 of the cookie notice..
cookieNoticeButton2FontColorHoverstring'#ffffff'the font color of the button 2 in hover state of the cookie notice.
cookieNoticeButtonDismissActionnumber0The action performed after clicking the dismiss button of the cookie notice.
cookieNoticeButtonDismissUrlstring''The action performed after clicking the dismiss button of the cookie notice.
cookieNoticeButtonDismissColorstring'#646464'the color of the dismiss button of the cookie notice.
cookieNoticeContainerPositionnumber2The position of the cookie notice. The possible values are: ‘0’ (Top), ‘1’ (Center), ‘2’ (Modal)
cookieNoticeContainerWidthnumber1140The width of the wrapper that includes the content of the cookie notice.
cookieNoticeContainerOpacitynumber1The opacity of the background of the cookie notice.
cookieNoticeContainerBorderWidthnumber0The width of the border of the cookie notice.
cookieNoticeContainerBackgroundColorstring'#ffffff'The background color of the cookie notice.
cookieNoticeContainerBorderColorstring'#e1e1e1'The opacity of the background of the cookie notice.
cookieNoticeContainerBorderOpacitynumber1The opacity of the border of the cookie notice.
cookieNoticeContainerDropShadowbooleantrueThe drop shadow of the container. The possible options are: ‘0’ (Disabled), ‘1’ (Enabled)
cookieNoticeContainerDropShadowColorstring'#242f42'The color of the mask displayed behind the cookie notice.
cookieNoticeMaskbooleantrueA mask placed behind the cookie notice to prevent user interactions with the website. The possible options are: ‘0’ (Disabled), ‘1’ (Enabled)
cookieNoticeMaskColorstring'#242f42'the color of the mask displayed behind the cookie notice
cookieNoticeMaskOpacitynumber0The opacity of the mask displayed behind the cookie notice.
cookieNoticeShakeEffectnumbertrueA shake effect will be applied on the cookie notice when the user click on the mask. The possible options are: ‘0’ (Disabled), ‘1’ (Enabled)
cookieSettingsLogoUrlstring''The URL of the logo.
cookieSettingsTitlestring'Cookie Settings'The title of the cookie settings modal window.
cookieSettingsDescriptionHeaderstringCustom HTMLThe description displayed in the header of the cookie settings modal window provided as simple text or HTML.
cookieSettingsToggleOnColorstring'#3a70c4'The color of the active toggles displayed in the cookie settings modal window.
cookieSettingsToggleOffColorstring'#808080'The color of the inactive toggles displayed in the cookie settings modal window.
cookieSettingsToggleMiscColorstring'#808080'The color of the miscellaneous toggles displayed in the cookie settings modal window.
cookieSettingsToggleDisabledColorstring'#e5e5e5'The color of the disabled toggles displayed in the cookie settings modal window.
cookieSettingsSeparatorColorstring'#e1e1e1'The color of the borders.
cookieSettingsChevronColorstring'#6e6e6e'The color of the chevron icon displayed in the cookie settings modal window.
cookieSettingsExpandCloseColorstring'#6e6e6e'the color of the expand icon displayed in the cookie settings modal window.
cookieSettingsDescriptionFooterstringCustom HTMLThe description displayed in the footer of the cookie settings modal window.
cookieSettingsButton1Textstring'Close'The text of the button 1 of the cookie settings modal window.
cookieSettingsButton1Actionnumber2The action performed after clicking the button 1 of the cookie settings. The possible values are: ‘0’ (Disabled), ‘1’ (Accept Cookies), ‘2’ (Close Cookie Settings), ‘3’ (Redirect to URL)
cookieSettingsButton1Urlstring''The URL where the user will be redirected after clicking the button 1 of the cookie settings modal window.
cookieSettingsButton1BackgroundColorstring'#ffffff'The background color of the button 1 of the cookie settings modal window.
cookieSettingsButton1BackgroundColorHoverstring'#ffffff'The background color of the button 1 in hover status of the cookie settings modal window.
cookieSettingsButton1BorderColorstring'#1e58b1'The border color of the button 1 of the cookie settings modal window.
cookieSettingsButton1BorderColorHoverstring'#1e58b1'The border color of the button 1 in hover state of the cookie settings modal window.
cookieSettingsButton1FontColorstring'#1e58b1'the font color of the button 1 of the cookie settings modal window.
cookieSettingsButton1FontColorHoverstring'#1e58b1'the font color of the button 1 in hover state of the cookie settings modal window.
cookieSettingsButton2Textstring'Accept'The text of the button 2 of the cookie settings modal window.
cookieSettingsButton2Actionnumber1The action performed after clicking the button 2 of the cookie settings. The possible values are: ‘0’ (Disabled), ‘1’ (Accept Cookies), ‘2’ (Close Cookie Settings), ‘3’ (Redirect to URL)
cookieSettingsButton2Urlstring''The URL where the user will be redirected after clicking the button 2 of the cookie settings modal window.
cookieSettingsButton2BackgroundColorstring'#1e58b1'The background color of the button 2 of the cookie settings modal window.
cookieSettingsButton2BackgroundColorHoverstring'#1e58b1'This option determines the background color of the button 2 in hover state of the cookie settings modal window.
cookieSettingsButton2BorderColorstring'#1e58b1'the border color of the button 2 of the cookie settings modal window.
cookieSettingsButton2BorderColorHoverstring'#1e58b1'The border color of the button 2 in hover state of the cookie settings modal window.
cookieSettingsButton2FontColorstring'#ffffff'The font color of the button 2 of the cookie settings.
cookieSettingsButton2FontColorHoverstring'#ffffff'The font color of the button 2 in hover state of the cookie settings.
cookieSettingsHeadingsFontColorstring'#222222'The font color of the headings of the cookie settings modal window.
cookieSettingsParagraphsFontColorstring'#666666'The font color of the paragraphs of the cookie settings modal window.
cookieSettingsLinksFontColorstring'#1e58b1'The font color of the links of the cookie settings modal window.
cookieSettingsContainerBackgroundColorstring'#ffffff'The background color of the cookie settings modal window.
cookieSettingsContainerOpacitynumber1.0The opacity of the background of the cookie settings.
cookieSettingsContainerBorderWidthnumber0The width of the border of the cookie settings.
cookieSettingsContainerBorderColorstring'#e1e1e1'The border color of the cookie settings modal window.
cookieSettingsContainerBorderOpacitynumber1.0The opacity of the cookie settings container border.
cookieSettingsContainerDropShadownumbertrueThe drop shadow of the container. The possible options are: ‘0’ (Disabled), ‘1’ (Enabled)
cookieSettingsContainerDropShadowColorstring'#242f42'The color of the drop shadow of the cookie settings container.
cookieSettingsContainerHighlightColorstring'#f8f8f8'The highlight color of the cookie settings modal window.
cookieSettingsMasknumbertrueA mask placed behind the cookie settings modal window to prevent user interactions with the website. The possible options are: ‘0’ (Disabled), ‘1’ (Enabled)
cookieSettingsMaskColorstring'#242f42'The color of the mask displayed behind the cookie settings modal window.
cookieSettingsMaskOpacitystring0.54The opacity of the mask displayed behind the cookie settings modal window.
enableGeolocationnumberfalseThe cookie notice will be displayed only to the users located in the countries defined with the geolocationLocale option. The possible options are: ‘0’ (Disabled), ‘1’ (Enabled)
geolocationServicenumber0The geolocation service used to detect the user location. The possible options are: ‘0’ (hostIP), ‘1’ (MaxMind GeoLite2)
geolocationLocalearray[
'at',
'be',
'bg',
'cy',
'cz',
'dk',
'ee',
'fi',
'fr',
'hu',
'ie',
'it',
'lv',
'lt',
'lu',
'mt',
'nl',
'pl',
'pt',
'sk',
'si',
'es',
'se',
'gb']
The list of countries where the cookie notice should be displayed. The countries should be specified with the ISO 3166-1 alpha-2 code.
responsiveBreakpointnumber700When the browser viewport width goes below this value, the mobile version of the cookie notice and cookie settings modal window will be used.
cookieExpirationnumber3153600000The amount of time the cookies used to store the acceptance status and the accepted categories should be stored.
reloadPagebooleanfalseWith this option enabled, when the user accepts the cookies, the page is reloaded.
cookieTableColumnsarray['name', 'expiration', 'purpose']The columns included in the table used to display the cookies.
cookieTableColumnsNamesobject{
name: 'Name',
expiration: 'Expiration',
purpose: 'Purpose',
provider: 'Provider',
domain: 'Domain',
type: 'Type',
sensitivity: 'Sensitivity',
security: 'Security',
}
The names of the columns included in the table used to display the cookies.
forceCssSpecificitybooleantrueThe CSS specificity will be force with the “!important” rule. The possible options are: ‘0’ (Disabled), ‘1’ (Enabled)
ajaxUrlstring'geolocation/init.php'The URL used to retrieve the geolocation information when the GeoLite2 database is used.
sectionsarray[]The data associated with the cookie categories. Please see the examples included in this manual for more details.