..  include:: /Includes.rst.txt


..  _for-editors-configuration-advanced:

========
Advanced
========

..  figure:: /Images/Configuration-Advanced.png
    :class: with-shadow
    :alt: Advanced tab of a Klaro configuration record

    Klaro Configuration - Advanced Tab

..  contents::
   :local:

Base Configuration
==================

Config Variable Name
--------------------

..  confval:: config_variable_name

    :type: string
    :Default: ''

    By default, Klaro loads the configuration from a global variable `klaroConfig`. You can change this here. Specifying this field will cause the attribute data-klaro-config="yourConfigVariableName" to be set.

Element ID
----------

..  confval:: element_i_d

    :type: string
    :Default: ''

    You can customize the ID of the `div` element that Klaro will create when starting up. By default, Klaro will use "klaro".

Style Prefix
------------

..  confval:: style_prefix

    :type: string
    :Default: (empty)

    Prefix for CSS classes/container to namespace Klaro styles.

Additional Class
----------------

..  confval:: additional_class

    :type: string
    :Default: ''

    You can specify an additional class (or classes) that will be added to the Klaro `div`

Storage
=======

..  _for-editors-configuration-advanced-storage-method:

Storage Method
--------------

..  confval:: storage_method

    :type: select
    :Default: 'cookie'

    You can customize how Klaro persists consent information in the browser.
    Specify either `cookie` (the default), `localStorage`, or the empty value
    for no persistent storage.

    **Options:**

    *   None `[empty value]`
    *   Cookie (default) `[cookie]`
    *   Local Storage `[localStorage]`

Storage Name
------------

..  confval:: storage_name

    :type: string
    :Default: ''

    You can customize the name of the cookie or localStorage entry that Klaro will use for storing the consent information. By default, Klaro will use "klaro".

Callback
========

Callback
--------

..  confval:: callback

    :type: string
    :Default: ''

    You can define an optional callback function that will be called each time
    the consent state for any given service changes. The consent value is passed
    as the first parameter (`true` means consented). The `service` config is
    passed as the second parameter. The content of this field is wrapped with
    `callback: function(consent, service) { }`.

    Enter only trusted JavaScript. Syntax errors or unsafe code in this field
    are emitted to the frontend configuration.