blauequelle/privacywire

Installs: 138

Dependents: 0

Suggesters: 0

Security: 0

Stars: 20

Watchers: 3

Forks: 3

Open Issues: 0

Type:pw-module

0.4.4 2020-12-04 10:00 UTC

This package is auto-updated.

Last update: 2021-01-07 09:08:40 UTC


README

Cookie & Consent Manager for ProcessWire

This module adds the possibility to define cookie / consent groups and load corresponding elements only after the site visitor has given consent.
The following cookie groups are available (the frontend visible label is editable and translatable, this is just the technical name)

  • Necessary
  • Functional
  • Statistics
  • Marketing
  • External Media
  • (All Cookies)
    Necessary elements are always active. You can let the user decide, which individual cookie group(s) should be allowed, and/or add an „Allow all“ button.

You can use the (very basic) styles or use the completely unstyled version. Both script version are very small and thus fast (around 6kb for the styled version and around 5.2kb for the unstyled version).

To load scripts, frames, images or other elements only after the site visitor has given consent to that specific cookie group, use the following attributes:

<script type=text/plain" data-type="text/javascript" data-category="functional">console.log("This script only runs after giving consent to functional cookies");</script>

You can even render and alternate Opt-In text instead of the element:

<iframe data-src="https://processwire.com/" data-category="marketing" data-ask-consent="1" frameborder="0" height="400" width="400"></iframe>

Availabe attributes:

Attribute Info Description Type
data-category required defines the assigned cookie group for this element string
data-type optional (required for scripts) replaces the type attribute after giving consent string
data-src optional (required for external scripts, images or iframes) replaces the src attribute after giving consent string
data-srset optional replaces the srcset attribute for images after giving consent string
data-ask-consent optional Replace element with Opt-In-Element bool 0/1

For script tags it is required to add type=text/plain", otherwise the script executes directly.

Textformatter to choose Cookie groups / Opt-Out

With PrivacyWire itself comes a Textformatter with the shortcode [[privacywire-choose-cookies]] to add a button to show the cookie group selection window.
To automatically include the Opt-In-Element for embedded videos via TextformatterVideoEmbed you can choose the cookie group in the Textformatter settings.

Multiple language support / i18n

The module uses the ProcessWire-integrated translation system.