68publishers-cookie-consent - npm Package Compare versions -...

@@ -22,2 +22,3 @@ <div align="center" style="text-align: center; margin-bottom: 50px">

* [Accessing the wrapper in the JavaScript](#accessing-the-wrapper-in-the-javascript)

* [Integration with CMP application](#integration-with-cmp-application)

* [How the GTM integration works](#how-the-gtm-integration-works)

@@ -52,10 +53,10 @@ * [How to update already published container](#how-to-update-already-published-containers)

| Field | Description |

| ------ | ------ |

| Package version | Version of the package `68publishers/cookie-consent`. Valid inputs are the `latest` or a version in formats `x.x.x`, `x.x.x-beta.x` and `x.x.x-alpha-x`. For available versions see the [releases](https://github.com/68publishers/cookie-consent/releases). |

| Make consent required | The page will be blocked until a user action. |

| Show the widget as soon as possible | The widget will be displayed automatically on the page load. You must trigger the widget manually by calling `CookieConsentWrapper.unwrap().show()` if the option is disabled. |

| Hide from bots | Enable if you don't want the plugin to run when a bot/crawler/webdriver is detected. |

| Revision | Revision number of your terms of use of cookies. For more information [see below](#how-to-manage-revisions). |

| Delay | Number of milliseconds before showing the consent modal. |

| Field | Description |

|-------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

| Package version | Version of the package `68publishers/cookie-consent`. Valid inputs are the `latest` or a version in formats `x.x.x`, `x.x.x-beta.x` and `x.x.x-alpha-x`. For available versions see the [releases](https://github.com/68publishers/cookie-consent/releases). |

| Make consent required | The page will be blocked until a user action. |

| Show the widget as soon as possible | The widget will be displayed automatically on the page load. You must trigger the widget manually by calling `CookieConsentWrapper.unwrap().show()` if the option is disabled. |

| Hide from bots | Enable if you don't want the plugin to run when a bot/crawler/webdriver is detected. |

| Revision | Revision number of your terms of use of cookies. For more information [see below](#how-to-manage-revisions). |

| Delay | Number of milliseconds before showing the consent modal. |

@@ -66,4 +67,6 @@ ### Consent & Setting modal options

The behavior of the consent modal buttons can be configured through fields `Primary button role`, `Secondary button role` (accept necessary cookies or open the settings modal), and `Buttons order`.

See the [widget documentation](https://github.com/orestbida/cookieconsent/tree/v2.7.1#layout-options--customization) for more details.

See the [widget documentation](https://github.com/orestbida/cookieconsent/tree/v2.8.3#layout-options--customization) for more details.

The consent modal has also an option `Show third button` that adds the third button to the modal. If the secondary button's role is `Open settings` the third button's role is `Accept necessary` and vice versa.

The settings modal has one special option with the name `Settings modal trigger selector`. A value of the option can be CSS selector for automatic creation of the trigger button that opens the modal. Check the [example](#settings-modal-trigger).

@@ -73,17 +76,17 @@

| Field | Description |

| ------ | ------ |

| Cookie name | The name of a cookie value that holds information about the user's consent. |

| Cookie expiration | Expiration of the cookie in days. |

| Enable cookies auto-clear | All cookies will be deleted based on the user's consent and a selected strategy if the option is enabled. |

| Cookies auto-clear strategy | Strategy for cookies auto-clear feature. |

| Cookie names | Names of the cookies that will be deleted or kept (based on a selected strategy). |

| Field | Description |

|-----------------------------|-----------------------------------------------------------------------------------------------------------|

| Cookie name | The name of a cookie value that holds information about the user's consent. |

| Cookie expiration | Expiration of the cookie in days. |

| Enable cookies auto-clear | All cookies will be deleted based on the user's consent and a selected strategy if the option is enabled. |

| Cookies auto-clear strategy | Strategy for cookies auto-clear feature. |

| Cookie names | Names of the cookies that will be deleted or kept (based on a selected strategy). |

The following strategies are implemented:

1) `Clear all except defined` - All cookies except those you define in the field `Cookie names` will be deleted when the user denies any storage.

2) `Clear defined only` - All cookies you defined in the field `Cookie names` will be deleted when the user denies any storage.

1) `Clear all except defined`<sup>*</sup> - All cookies except those you define in the field `Cookie names` will be deleted when the user denies any storage.

2) `Clear defined only`<sup>*</sup> - All cookies you defined in the field `Cookie names` will be deleted when the user denies any storage.

3) `Use cookie tables` - Cookie clearing is based on cookie tables from the original [plugin](https://github.com/orestbida/cookieconsent). Integration of [CMP application](#integration-with-cmp-application) is required for this option.

There is no need to define a name from the `Cookie name` field because this cookie is never automatically deleted.

The option `autoclear_cookies` from the original [plugin](https://github.com/orestbida/cookieconsent) is not currently supported because cookie tables are not implemented in this package.

<sup>*</sup> There is no need to define a name from the `Cookie name` field because this cookie is never automatically deleted.

@@ -102,10 +105,10 @@ ### Storage options

| Field | Description |

| ------ | ------ |

| Enabled by default | A storage has `granted` consent by default if the option is checked. Triggers will be invoked as soon as possible. |

| Display in the widget | A storage will be displayed inside the settings modal if the option is checked. |

| Readonly | A toggle button for storage inside the settings modal will be disabled if the option is checked. Commonly used for functionality storage. The option is available only if the option `Display in the widget` is checked. |

| Synchronize consent with | The consent can be synchronized with another storage. The option is available only if the option `Display in the widget` is not checked. |

| Show the modal again if storage is denied | The settings modal will be opened again after the specified number of days if the storage is denied. The option is available only if the option `Display in the widget` is not checked. |

| Event trigger name | The name of an event trigger that will be invoked on `granted` consent with storage. The name may not be unique for each storage (unique triggers are invoked only). No trigger is invoked if the option has an empty value. |

| Field | Description |

|-------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

| Enabled by default | A storage has `granted` consent by default if the option is checked. Triggers will be invoked as soon as possible. |

| Display in the widget | A storage will be displayed inside the settings modal if the option is checked. |

| Readonly | A toggle button for storage inside the settings modal will be disabled if the option is checked. Commonly used for functionality storage. The option is available only if the option `Display in the widget` is checked. |

| Synchronize consent with | The consent can be synchronized with another storage. The option is available only if the option `Display in the widget` is not checked. |

| Show the modal again if storage is denied | The settings modal will be opened again after the specified number of days if the storage is denied. The option is available only if the option `Display in the widget` is not checked. |

| Event trigger name | The name of an event trigger that will be invoked on `granted` consent with storage. The name may not be unique for each storage (unique triggers are invoked only). No trigger is invoked if the option has an empty value. |

@@ -136,6 +139,6 @@ ### Event triggers based on composite consent

| Field | Description |

| ------ | ------ |

| Locale detection strategy | `Browser` to get user's browser language or `Document` to read a value from `<html lang="...">` of the current page. |

| Locale | You must define the website locale when the detection strategy is disabled. The locale must be one of the previously defined locales in the field `Locales`. |

| Field | Description |

|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|

| Locale detection strategy | `Browser` to get user's browser language or `Document` to read a value from `<html lang="...">` of the current page. |

| Locale | You must define the website locale when the detection strategy is disabled. The locale must be one of the previously defined locales in the field `Locales`. |

@@ -149,18 +152,18 @@ ### How to manage revisions

*<sup>Note: the <a href="https://github.com/orestbida/cookieconsent/tree/v2.7.1#how-to-enablemanage-revisions">cookieconsent plugin</a> uses the placeholder `{{revision_message}}` but this notation is used by GTM for variables so the package comes with the placeholder `[[revision_message]]` instead.</sup>*

*<sup>Note: the <a href="https://github.com/orestbida/cookieconsent/tree/v2.8.3#how-to-enablemanage-revisions">cookieconsent plugin</a> uses the placeholder `{{revision_message}}` but this notation is used by GTM for variables so the package comes with the placeholder `[[revision_message]]` instead.</sup>*

### Stylesheets

| Field | Description |

| ------ | ------ |

| Field | Description |

|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

| Include default stylesheets | The default stylesheet for the widget will be loaded into the page if the option is checked. We recommend keeping the option checked and adding custom stylesheets through the next options. |

| External stylesheets | The list of custom CSS stylesheets. One URL per line. |

| Internal stylesheet | Custom CSS rules that will be injected into the page after default stylesheets and other external stylesheets. |

| External stylesheets | The list of custom CSS stylesheets. One URL per line. |

| Internal stylesheet | Custom CSS rules that will be injected into the page after default stylesheets and other external stylesheets. |

### Page scripts

| Field | Description |

| ------ | ------ |

| Manage page scripts | Enable if you want to easily manage existing `<script>` tags. |

| Script selector | The name of a data attribute that is used for managed <script> tags. |

| Field | Description |

|---------------------|----------------------------------------------------------------------|

| Manage page scripts | Enable if you want to easily manage existing `<script>` tags. |

| Script selector | The name of a data attribute that is used for managed <script> tags. |

@@ -257,3 +260,3 @@ Managing page scripts is disabled by default. When the feature is enabled then the following notation can be used for scripts you want to manage:

The only currently available event is `init`. A callback is invoked when the wrapper is fully initialized or directly if everything has been already initialized.

A callback is invoked when the wrapper is fully initialized or directly if everything has been already initialized.

@@ -272,2 +275,63 @@ ```html

### Consent events

```html

CookieConsentWrapper.on('consent:first-action', function (consent) {

// called on the first user's action

});

CookieConsentWrapper.on('consent:accepted', function (consent) {

// called on every page load after the first user's action

});

CookieConsentWrapper.on('consent:changed', function (consent, changedCategories) {

// called when preferences changed

});

</script>

```

### Locale event

```html

CookieConsentWrapper.on('locale:change', function (locale) {

// called when the plugin locale is changed through method `CookieConsentWrapper.changeLocale()`

console.log(locale + '!');

});

// ...

CookieConsentWrapper.changeLocale('cs', true) // cs!

CookieConsentWrapper.changeLocale('en', true) // en!

</script>

```

## Integration with CMP application

The widget can be integrated with [the CMP application](https://github.com/68publishers/consent-management-platform).

The first thing to do is to set up the user information under the `Integration` section. Each user must have an identity (ID).

The default option is `Generated UUID`, however you can set a custom GTM variable that will return the ID of the current user of your website.

The ID will be accessible in all your translations with placeholder `[[user_identity]]`.

You can also set other attributes that will be sent to the CMP application along with the consents.

Configuration of the CMP application is easy, just set the URL of your application and the project code (if you leave it blank, the site domain is used as the code).

The configuration includes two options

- Consent API enabled

- Cookies API enabled

If you check the `Cookies API enabled` option, the widget will automatically send consents to the CMP application.

If you check the `Cookies API enabled` option then the widget will automatically pull all cookies from the CMP application for the project and creates cookie tables from them.

Below this field you can define which columns the cookie table should contain.

## How the GTM integration works

@@ -292,4 +356,7 @@

- :fast_forward: The [original plugin](https://github.com/orestbida/cookieconsent) is initialized

- :fire: Callbacks for an [event](#init-event) `CookieConsentWrappe.on('init')` are fired

- :fire: Callbacks for an [event](#init-event) `CookieConsentWrapper.on('init')` are fired

- :eye: The consent modal is shown if a user has not yet agreed to the use of cookies

- :fire: After user's action, callbacks for an [event](#consent-events) `CookieConsentWrapper.on('consent:first-action')` are fired

- :arrows_counterclockwise: The consent is sent into the CMP application

- :fire: Callbacks for an [event](#consent-events) `CookieConsentWrapper.on('consent:accepted')` are fired

@@ -300,2 +367,4 @@ #### User updates his preferences through the setting modal

- :fire: Custom triggers for newly granted storage types are fired

- :fire: Callbacks for an [event](#consent-events) `CookieConsentWrapper.on('consent:changed')` are fired

- :arrows_counterclockwise: The consent is sent into the CMP application

@@ -302,0 +371,0 @@ ## How to update already published containers

		{
		"name": "68publishers-cookie-consent",
		"version": "0.4.0-beta.9",
		"version": "0.4.0-beta.10",
		"description": "Cookie consent wrapper based on orestbida/cookieconsent with GTM integration.",
		@@ -39,3 +39,3 @@ "homepage": "http://www.68publishers.io/",
		"uuid": "^8.3.2",
		"vanilla-cookieconsent": "^2.8.3",
		"vanilla-cookieconsent": "^2.8.6",
		"whatwg-fetch": "^3.6.2"
		@@ -42,0 +42,0 @@ },

68publishers-cookie-consent - npm Package Compare versions

New alerts

Fixed alerts

Improved metrics

Dependency changes