Skip to content

Latest commit

 

History

History
76 lines (41 loc) · 1.84 KB

Index.rst

File metadata and controls

76 lines (41 loc) · 1.84 KB
Raw

Custom themes

Target group: Developers, Integrators

Create a new theme or adapt an existing one

Note

We are happy to receive pull-requests for new themes!

This is a recommendation how to set up your template structure for a custom extension.

  1. Set your base path in TypoScript constants:
plugin.tx_cookieman.settings.resourcesBasePath = EXT:your_ext/Extensions/cookieman/Resources
  1. Choose a new theme name:
plugin.tx_cookieman.settings.theme = myTheme
  1. Create folder EXT:your_ext/Extensions/cookieman/Resources/Private/Themes/myTheme/. Add 3 folders: Templates, Partials, Layouts.
  2. These folders will have the highest priority when looking for templates, partials or layouts now. The fallback will be EXT:cookieman/Resources/Private/*.
  3. Create folder EXT:your_ext/Extensions/cookieman/Resources/Public/Themes/myTheme. This will hold the files cookieman-theme(.min).css and cookieman-theme(.min).js. Reimplement the methods cookieman.show() and cookieman.hide() in cookieman-theme(.min).js.
  4. Copy the .css, .js and .html files as needed from a default theme.
  5. Adapt the HTML/CSS/JS as needed.

Storing user consent

These HTML element attributes control the functionality:

<* data-cookieman-save>

Save and close

<* data-cookieman-accept-all>

Mark all checkboxes

They can appear multiple times and also together on the same element.

Example:

<button rel="nofollow" class="btn btn-primary"
        data-cookieman-accept-all
        data-cookieman-save>
            {f:translate(key: 'accept')}
</button>