Skip to content
This project contains a Gantry Atom and adds the Cookie Consent functionality to the Gantry templating framework.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
build
platform/joomla
screenshots
src
.gitignore
LICENSE
README.md

README.md

Cookie Consent Neo - Atom for Gantry

This project contains a Gantry Atom and adds the Cookie Consent Javascript API functionality to the Gantry templating framework. Cookie Consent Neo encapsulates the parameterization of the Cookie Consent banner within a Gantry Atom. Furthermore, it provides an easy, user friendly and GUI assisted configuration and integration. In the current revision the following CMSs are supported:

  • Joomla
  • Wordpress
  • Grav

Prerequisites

  • CMS (Joomla, Wordpress, Grav)
  • Gantry templating framework and theme
  • Cookie Consent API 3.x.x

Download

Choose the correct download for your target platform. The Joomla plugin system is supported for all Gantry themes globally or locally for the templates Helium and Hydrogen. The latest Atom version is v1.5.7.

Attention: When migrating from v1.4.7 or below to v1.5.0 or higher the existing settings of the atom will be reset.


Default Atom: English / Italian / German

Legacy Atom - Gantry <5.3.2: English / Italian / German

Joomla Plugin - All Templates (Global): English / Italian / German

Joomla Plugin - Hydrogen: English / Italian / German

Joomla Plugin - Helium: English / Italian / German


Automatic Installation (Joomla only)

  1. Download the plugin of the Cookie Consent Neo Atom for Hydrogen, Helium or Global installation.
  2. Install it over the Joomla plugin system.

If you install the plugin globally be aware that the resource location changes to /media/gantry5/engines/nucleus

Manual Installation

  1. Download the Default or Legacy Package of the Cookie Consent Neo Atom. If you are using Gantry <5.3.2 please use the Legacy Package for compatibility reasons.
  2. Extract the files.
  3. Copy the .html.twig and the .yaml file to your Particle folder /[GANTRY_THEME]/custom/particles. Please check the listing below to determine where the template folder for your CMS is located.
  4. [Optional] Copy the .js file(s) to the folder /[GANTRY_THEME]/custom/js. Create the folder if it does not exist.
  5. [Optional] Copy the .css file(s) to the folder /[GANTRY_THEME]/custom/css. Create the folder if it does not exist.

CMS Template Folder

Please be aware that the template folder path varies in dependence of the used CMS. Here is a list of the folders for the different platforms:

Wordpress

/wp-content/themes/[GANTRY_THEME]

Joomla

/templates/[GANTRY_THEME]

Grav

/user/data/gantry5/themes/[GANTRY_THEME]

Configuration

  1. Go to your Gantry templating backend (e.g. Extensions/Templates).
  2. Switch to Page Settings and add the new appearing Atom called Cookie Consent Neo either globally to your site (base outline), to a specific template or page by dragging it to the designated section.
  3. Configure the appearance according to your favor.
  4. [Optional] The download package contains a modified version of the Cookie Consent JS file. You can embed it over the backend configuration. If you chose automatic installation the file is already there. It contains fixes for:
    • the floating behavior on mobile devices #277
    • the opt-in / opt-out button markup #464 / #468
  5. [Optional] The download package contains the original version of the Cookie Consent CSS file. You can embed it over the backend configuration if you do not want to use the default CDN. If you chose automatic installation the file is already there.

Supported Parameters and Atom Options

  • Banner Message Text
  • Enable / Disable 'Learn More' link
  • URL for the 'Learn More' link
  • Target for the 'Learn More' link
  • Dismiss Button Text
  • Revoke Button Text
  • Banner Position
  • Banner Layout
  • Banner Palette (sixteen default styles, taken from Cookie Consent)
  • Custom Popup/Banner Palette
    • Background Color
    • Text Color
    • Link Color
  • Custom Button Palette
    • Background Color
    • Text Color
  • Compliance Mode supported
  • Revokable supported
  • Rendering Delay
  • Scrolling and Timeout supported
  • White-/Blacklisting
  • Cookie Configuration
    • Server and Path
    • Cookie Name
    • Expiry
  • Location Configuration
    • Service Endpoints
    • Service Timeout
    • Country Code
  • Multi Language Support
    • Internationalization by Language Code
  • Adaptable Cookie Consent API Version
  • JS and CSS Configuration
    • Remote, Local and Default
    • Priority and Position (head or footer)
  • JS Execution
    • Asynchronous
    • Deferred

Showroom

Insight of the Cookie Consent Neo - Gantry Atom configuration:

Backend (1a) - Labeling a)

1

Backend (1b) - Labeling b)

2

Backend (2) - Appearance

3

Backend (3) - Behaviour

4

Backend (4) - Cookie

5

Backend (5) - Location

6

Backend (6) - API

7

Examples for some of the different Cookie Consent layouts and styles:

Frontend (1) - Floating

8

Frontend (2) - Wire

9

Frontend (3) - Banner

10

Future Tasks

  • better coverage of the Cookie Consent API parameters
  • maintain API changes
  • add more palettes
  • add more languages

Known Issues

None

Dependencies

Cookie Consent API

Gantry Framework

Credits

Thanks to the Gantry team for providing a modern templating framework.

Thanks to Insites for the Cookie Consent API.

Thanks to mariantanase for the Italian back- and frontend translation.

by thex | gantryparticles

Copyright (c) 2018, free to use in personal and commercial software as per the license.

You can’t perform that action at this time.