PHPackages                             zephir/kirby-cookieconsent - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. zephir/kirby-cookieconsent

ActiveKirby-plugin[Utility & Helpers](/categories/utility)

zephir/kirby-cookieconsent
==========================

Kirby cookieconsent plugin

3.2.1(1y ago)515.3k↑94.9%3[5 issues](https://github.com/zephir/kirby-cookieconsent/issues)[1 PRs](https://github.com/zephir/kirby-cookieconsent/pulls)MITPHP

Since Jul 7Pushed 1y ago3 watchersCompare

[ Source](https://github.com/zephir/kirby-cookieconsent)[ Packagist](https://packagist.org/packages/zephir/kirby-cookieconsent)[ RSS](/packages/zephir-kirby-cookieconsent/feed)WikiDiscussions main Synced 2d ago

READMEChangelog (9)Dependencies (1)Versions (9)Used By (0)

Kirby Cookieconsent plugin
==========================

[](#kirby-cookieconsent-plugin)

[![cover](docs/cover.png)](docs/cover.png)

A plugin to implement [cookieconsent](https://github.com/orestbida/cookieconsent) in Kirby.

- Uses the open source cookieconsent library
- Provides default translations for 5 cookie categories
- Multilingual support (EN/DE/FR)
- Customizable

Table of Contents
-----------------

[](#table-of-contents)

- [Kirby Cookieconsent plugin](#kirby-cookieconsent-plugin)
    - [Table of Contents](#table-of-contents)
    - [1. Installation](#1-installation)
        - [1.1 Composer](#11-composer)
        - [1.2 Download](#12-download)
        - [1.3 Git submodule](#13-git-submodule)
    - [2. Setup](#2-setup)
    - [3. Options](#3-options)
        - [3.1 Available options](#31-available-options)
        - [3.2 Defaults](#32-defaults)
        - [3.3 Predefined cookie categories](#33-predefined-cookie-categories)
        - [3.4 Removing a category](#34-removing-a-category)
    - [4. Language](#4-language)
    - [5. Translations](#5-translations)
        - [5.1 Overriding specific translations](#51-overriding-specific-translations)
    - [6. Events](#6-events)
    - [License](#license)
    - [Credits](#credits)

1. Installation
---------------

[](#1-installation)

The recommended way of installing is by using Composer.

### 1.1 Composer

[](#11-composer)

```
composer require zephir/kirby-cookieconsent

```

### 1.2 Download

[](#12-download)

Download and copy this repository to `/site/plugins/kirby-cookieconsent`.

### 1.3 Git submodule

[](#13-git-submodule)

```
git submodule add https://github.com/zephir/kirby-cookieconsent.git site/plugins/kirby-cookieconsent

```

2. Setup
--------

[](#2-setup)

Add `snippet('cookieconsentCss')` to your header and `snippet('cookieconsentJs')` to your footer.

3. Options
----------

[](#3-options)

### 3.1 Available options

[](#31-available-options)

OptionTypeDefaultDescriptionrootstring`"document.body"`[Root (parent) element where the modal will be appended as a last child.](https://cookieconsent.orestbida.com/reference/configuration-reference.html#root)autoShowboolean`true`[Automatically show the consent modal if consent is not valid.](https://cookieconsent.orestbida.com/reference/configuration-reference.html#autoshow)revisioninteger`1`[Manages consent revisions; useful if you'd like to ask your users again for consent after a change in your cookie/privacy policy.](https://cookieconsent.orestbida.com/advanced/revision-management.html#enable-revisions)autoClearCookiesboolean`true`[Clears cookies when user rejects a specific category. It requires a valid autoClear array.](https://cookieconsent.orestbida.com/reference/configuration-reference.html#autoclearcookies)hideFromBotsboolean`true`[Stops the plugin's execution when a bot/crawler is detected, to prevent them from indexing the modal's content.](https://cookieconsent.orestbida.com/reference/configuration-reference.html#hidefrombots)disablePageInteractionboolean`true`[Creates a dark overlay and blocks the page scroll until consent is expressed.](https://cookieconsent.orestbida.com/reference/configuration-reference.html#disablepageinteraction)lazyHtmlGenerationboolean`true`[Delays the generation of the modal's markup until they're about to become visible, to improve the TTI score. You can detect when a modal is ready/created via the onModalReady callback.](https://cookieconsent.orestbida.com/reference/configuration-reference.html#lazyhtmlgeneration)guiOptionsarray[see below](#32-defaults)[You can extensively customize both the color scheme and the layout, based on your needs.](https://cookieconsent.orestbida.com/advanced/ui-customization.html)categoriesarray[see below](#32-defaults)[Use to define your cookie categories.](https://cookieconsent.orestbida.com/reference/configuration-reference.html#categories)translationsarray[see below](#32-defaults)An array of translations for each language.languagearray[see below](#32-defaults)Defines the language and direction for single language installations.cdnboolean`false`Whether to load the cookieconsent assets from jsdelivr.net or use the compiled assets provided with this plugin.### 3.2 Defaults

[](#32-defaults)

```
'zephir.cookieconsent' => [
    'cdn' => false,
    'revision' => 1,
    'root' => 'document.body',
    'autoClearCookies' => true, // Only works when the categories have an autoClear array
    'autoShow' => true,
    'hideFromBots' => true,
    'disablePageInteraction' => false,
    'lazyHtmlGeneration' => true,
    'guiOptions' => [
        'consentModal' => [
            'layout' => 'box',
            'position' => 'bottom right',
            'flipButtons' => false,
            'equalWeightButtons' => true
        ],
        'preferencesModal' => [
            'layout' => 'box',
            // 'position' => 'left', // only relevant with the "bar" layout
            'flipButtons' => false,
            'equalWeightButtons' => true
        ]
    ],
    'categories' => [
        'necessary' => [
            'enabled' => true,
            'readOnly' => true
        ],
        'measurement' => [],
        'functionality' => [],
        'experience' => [],
        'marketing' => []
    ],
    'translations' => [
        'de' => require_once(__DIR__ . '/translations/de.php'),
        'en' => require_once(__DIR__ . '/translations/en.php'),
        'fr' => require_once(__DIR__ . '/translations/fr.php')
    ],
    'language' => [
        'locale' => 'en',
        'direction' => 'ltr'
    ]
]
```

### 3.3 Predefined cookie categories

[](#33-predefined-cookie-categories)

Each cookie category can be used to control certain scripts. To learn how to manage scripts, head over to the [CookieConsent documentation](https://cookieconsent.orestbida.com/advanced/manage-scripts.html#how-to-manage-scripts).

Categories that are predefined by this plugin:

NameEnabledDescriptionnecessary✅The necessary cookies, can't be disabled by the user.functionality✅Cookies for basic functionality and communication.experience✅Cookies to improve the quality of the user experience and enable the user to interact with external content, networks and platforms.measurement✅Cookies that help to measure traffic and analyze behavior.marketing✅These cookies help us to deliver personalized ads or marketing content to you, and to measure their performance.> Predefined means that there are translations in all languages for each category.

To enable/disable categories you can use the `categories` option of the plugin.

```
'zephir.cookieconsent' => [
    'categories' => [
        'necessary' => [
            'enabled' => true, // marks the category as enabled by default
            'readOnly' => true
        ],
        'measurement' => [],
        'functionality' => [],
        'experience' => [],
        'marketing' => []
    ],
]
```

> An empty array defines the category with the default options. You can pass additional options like `enabled` or `readOnly` in the array. Learn more about those options in the [CookieConsent Documentation](https://cookieconsent.orestbida.com/reference/configuration-reference.html#categories).

### 3.4 Removing a category

[](#34-removing-a-category)

To remove a category you have to set its value to `false`.

```
'zephir.cookieconsent' => [
    'categories' => [
        'necessary' => [
            'enabled' => true,
            'readOnly' => true
        ],
        'measurement' => [],
        'functionality' => false, // will not be shown
        'experience' => false, // will not be shown
        'marketing' => []
    ],
]
```

4. Language
-----------

[](#4-language)

If you have a single language setup (kirby option `languages` not set to `true`), you will have to define the `language` option of the plugin. For multi-language setups you don't have to do anything, the plugin automatically uses the kirby language or falls back to the first translation in the translations array.

```
'zephir.cookieconsent' => [
    'language' => [
        'locale' => 'de', // The translation to use, default is en
        'direction' => 'ltr' // Either ltr or rtl, default is ltr
    ]
]
```

5. Translations
---------------

[](#5-translations)

The translations are a central part of the plugin. By default, we provide translations for EN, DE, FR and the categories mentioned in [3.3 Predefined cookie categories](#33-predefined-cookie-categories). To customise or override the default translations, you will need to use the `translations` option.

### 5.1 Overriding specific translations

[](#51-overriding-specific-translations)

> For this example we are overriding one string and adding a new category in the sections part of the EN translation.

1. Create a new folder in your project. For this example we call it `cc-translations`.
2. In that folder, create a new file `en.php`.

```