Klaro! Configuration true false General Layout Content Cookie Advanced Access General Base Configuration Storage Services Cookie Settings Callback Default consent status Other display settings Layout settings Behavior Hide Buttons Append Buttons Access Translations Title Title under which this configuration can be found. My Klaro! Configuration Testing Setting `testing` to `true` will cause Klaro to not show the consent notice or modal by default, except if a special hashtag is appended to the URL (#klaro-testing). This makes it possible to test Klaro on your live website without affecting normal visitors. Config Variable Name 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. klaroConfig Element ID You can customize the ID of the `div` element that Klaro will create when starting up. By default, Klaro will use "klaro". klaro No Auto-Load Setting this to `true` will keep Klaro from automatically loading itself when the page is being loaded. Additional Class You can specify an additional class (or classes) that will be added to the Klaro `div`. my-klaro Storage Method You can customize how Klaro persists consent information in the browser. Specify either `cookie` (the default) or `localStorage`. None Cookie (default) Local Storage Storage Name 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". klaro HTML Texts If set to `true`, Klaro will render the texts given in the `consentModal.description` and `consentNotice.description` translations as HTML. This enables you to e.g. add custom links or interactive content. If you want to be able to output HTML tags via fluid-enriched labels (see "Content" → "Translations"), this option must be enabled. Embedded Setting "embedded" to `true` will render the Klaro modal and notice without the modal background, allowing you to e.g. embed them into a specific element of your website, such as your privacy notice. Group by purpose You can group services by their purpose in the modal. This is advisable if you have a large number of services. Users can then enable or disable entire groups of services instead of having to enable or disable every service. Cookie Domain You can change the cookie domain for the consent manager itself. Use this if you want to get consent once for multiple matching domains. By default, Klaro will use the current domain. Only relevant if `storageMethod` is set to `cookie`. .example.com Cookie Path Provide a path if you have services that set cookies for a path that is not "/" / Cookie expires after days You can also set a custom expiration time for the Klaro cookie. By default, it will expire after 60 days. Only relevant if `storageMethod` is set to `cookie`. 30 Default Defines the default state for services in the consent modal (`true` = enabled by default). If this setting is set to "false", you can override it in any service. Must consent If `mustConsent` is set to `true`, Klaro will directly display the consent manager modal and not allow the user to close it before having actively consented to or declined the use of third-party services. Accept all Setting `acceptAll` to `true` will show an "accept all" button in the notice and modal, which will enable all third-party services if the user clicks on it. If set to "false", there will be an "accept" button that will only enable the services that are enabled in the consent modal. Hide Decline All Setting `hideDeclineAll` to `true` will hide the "decline" button in the consent modal and force the user to open the modal in order to change his/her consent or disable all third-party services. We strongly advise you to not use this feature, as it opposes the "privacy by default" and "privacy by design" principles of the GDPR (but might be acceptable in other legislations such as under the CCPA) Hide Learn More Setting `hideLearnMore` to `true` will hide the "learn more / customize" link in the consent notice. We strongly advise against using this under most circumstances, as it keeps the user from customizing his/her consent choices. Hide Toggle All Setting `hideToggleAll` to `true` will hide the "toggle all" link in the consent notice. Notice As Modal Show cookie notice as modal Show title in consent notice When this option is enabled, Klaro displays the title in the notice modal. Show Description (Empty Store) Show an explanatory text in contextual consent placeholders when no consent storage exists yet (first visit / empty store). This informs users that a permanent decision ("Always") requires allowing Klaro to store consent first. This only has an effect in contextual consent widgets/overlays (e.g. for embedded media) and only if the consent store (cookie/localStorage) is empty. Auto Focus Automatically focus the Klaro consent notice/modal container when it opens to improve keyboard navigation and accessibility. Disable Powered By You can also remove the "Realized with Klaro!" text in the consent modal. Please don't do this! We provide Klaro as a free open source tool. Placing a link to our website helps us spread the word about it, which ultimately enables us to make Klaro! better for everyone. So please be fair and keep the link enabled. Thanks :) Services Here you specify the third-party services that Klaro will manage for you. Purpose Order The order in which purposes appear in the notice and modal can be changed via the `purposeOrder` parameter, which can be given a list with purpose names and will display those purposes in the order in which they appear in the list. Callback You can define an optional callback function that will be called each time the consent state for any given service changes. The consent value will be passed as the first parameter to the function (`true` = consented). The `service` config will be passed as the second parameter. The content of this field is wrapped with `callback: function(consent, service) { }` Locallang Path Optional path to an additional XLIFF file that overwrites the default labels or adds new labels (e.g. for custom purposes or services). If fluid templates have been stored for the labels created in this file (see the "Fluid Template Root Path" field), these will overwrite the classic labels from the Locallang file. Nevertheless, it is possible and common to reference the locallang file from the respective fluid template and obtain the actual label there (the label key is passed to the fluid template). EXT:sitepackage/Resources/Private/Language/Klaro/locallang.xlf Fluid Template Root Path As an alternative to the usual TypoScript configuration via constants under `plugin.tx_klaroconsentmanager.view`, a Fluid root path can be defined here, which has a higher priority than the paths configured in TypoScript. The three default directories `/Layouts/`, `/Partials/` and `/Templates/` are expected under this path. Fluid templates created here are used to enrich Locallang labels with additional functionality or to replace them completely. In this way, dynamic content or more complex HTML structures can be provided in a simple way. Fluid templates that are to override labels are expected in the subdirectory `/Templates/Labels/`. EXT:sitepackage/Resources/Private/ Alignment Determines the alignment of the Consent box if `mustConsent` and `noticeAsModal` are disabled. Top-Left Top-Right Top-Wide Bottom-Left Bottom-Right Bottom-Wide Top Bottom left right wide Color Scheme Default color scheme used for the display. The colors can also be overridden later via CSS variables. Dark (neutral) Light (neutral) Dark Light Append Show Button If this option is set to `true`, a button is created in the frontend (via JavaScript) directly in front of the closing body tag, which triggers the opening of the Klaro consent management. Append Reset Button If this option is set to `true`, a button is generated in the frontend (via JavaScript) directly in front of the closing body tag, which triggers the resetting of all settings and the opening of the Klaro consent management. Configuration visible Klaro! Service General Cookies Toggles Advanced Access General Settings Cookie Settings Toggles Advanced Settings Access true false Name Each service must have a unique name. Klaro will look for HTML elements with a matching `data-name` attribute to identify elements that belong to this service. matomo Title The title defined here is not mandatory and is intended for backend display only. Matomo/Piwik Adobe Fonts Google AdSense Surveillance Camera Career Captain Microsoft Clarity Cloudflare External Tracker Facebook Pixel Fast Fonts Google Ads Google Analytics Google Fonts Google Maps Google Tag Manager Inline Tracker Instagram Intercom Klaro! Matomo/Piwik Mouseflow SalesViewer TikTok X (formerly Twitter) Userlike Vimeo YouTube Default If `default` is set to `true`, the service will be enabled by default. This overrides the global `default` setting (if this is set to "false"). Purposes The purpose(s) of this service that will be listed on the consent notice. Do not forget to add translations for all purposes you list here. Custom Default Additional Functional Performance Marketing Advertising Analytics Security Live Chat Styling Videos Social Media Miscellaneous Cookies You can either only provide a cookie name or regular expression (regex) or a list consisting of a name or regex, a path and a cookie domain. Providing a path and domain is necessary if you have services that set cookies for a path that is not "/", or a domain that is not the current domain. If you do not set these values properly, the cookie can't be deleted by Klaro, as there is no way to access the path or domain of a cookie in JS. Notice that it is not possible to delete cookies that were set on a third-party domain, or cookies that have the HTTPOnly attribute: https://developer.mozilla.org/en-US/docs/Web/API/Document/cookie#new-cookie_domain Required If `required` is set to `true`, Klaro will not allow this service to be disabled by the user. Use this for services that are always required for your website to function (e.g. shopping cart cookies). Opt-Out If `optOut` is set to `true`, Klaro will load this service even before the user has given explicit consent. We strongly advise against this. Only Once If `onlyOnce` is set to `true`, the service will only be executed once regardless how often the user toggles it on and off. This is relevant e.g. for tracking scripts that would generate new page view events every time Klaro disables and re-enables them due to a consent change by the user. Contextual Consent Only Content can be excluded from general consent by setting contextualConsentOnly to `true`. In this case, the consent must be contextual. Callback You can define an optional callback function that will be called each time the consent state for the given service changes. The consent value will be passed as the first parameter to the function (`true` = consented). The `service` config will be passed as the second parameter. The content of this field is wrapped with `callback: function(consent, service) { }`. `consent` is a bool that reflects the current state. `service` holds all information about the currently selected service. When you enter something here, you need to know what you are doing. It is your responsibility that no JavaScript errors occur. `onAccept` callback function Here you can define JavaScript code that will be called each time the service was accepted. The content of this field is wrapped with `callback: function(handlerOpts) { }`. The object `handlerOpts` contains the objects `config` (the current Klaro! configuration), `service` (the current service) and possibly `vars` (any values defined by object notation in the vars field in the backend). When you enter something here, you need to know what you are doing. It is your responsibility that no JavaScript errors occur. `onInit` callback function Here you can define JavaScript code that will be called once per page-load. The content of this field is wrapped with `callback: function(handlerOpts) { }`. The object `handlerOpts` contains the objects `config` (the current Klaro! configuration), `service` (the current service) and possibly `vars` (any values defined by object notation in the vars field in the backend). When you enter something here, you need to know what you are doing. It is your responsibility that no JavaScript errors occur. `onDecline` callback function Here you can define JavaScript code that will be called each time the service was declined. The content of this field is wrapped with `callback: function(handlerOpts) { }`. The object `handlerOpts` contains the objects `config` (the current Klaro! configuration), `service` (the current service) and possibly `vars` (any values defined by object notation in the vars field in the backend). When you enter something here, you need to know what you are doing. It is your responsibility that no JavaScript errors occur. Variables Variables that can be used in callback functions. The content of this field is enclosed in curly brackets. The JavaScript object notation is expected in them. When you enter something here, you need to know what you are doing. It is your responsibility that no JavaScript errors occur. Service visible Cookie General Access Identification and presentation of the cookie Technically relevant settings This information is technically evaluated by Klaro! to manipulate the cookie. Expiration Time Access Identifier This is a unique identifier for this cookie. It must be written in lower case and must not contain any spaces, only the characters a-z, 0-9 and "-" or "_". The identifier can be used in Fluid, for example. lowercase_alphanum-x Title If set, this title will be used in the frontend/backend for displaying the cookie. This title has no technical relevance (contrary to the `pattern` field). mf_[Session] Name / Pattern Name or regular expression (regex) /^_pk_.*$/ Path Provide a path if you have services that set cookies for a path that is not "/" / Domain Provide a domain if you have services that set cookies for a domain that is not the current domain. klaro.kiprotect.com Expires after Number of years/months/days/hours/minutes/seconds that will elapse before this cookie expires. 60 Expires after unit Unit used for the "Expires after" specification. The special value `end-of-session` does not need a numeric value and hides the "Expires after" field accordingly. Years Months Days Hours Minutes Seconds End of session Persistent Cookie visible Contextual Consent When a service is selected in this field, the content item is displayed via contextual consent only if the user has agreed to use the selected service in the Klaro! Consent Manager. Please make sure that the static TypoScript template of the Klaro! Consent Manager has been added to use this feature. Hide initial consent notice Do not show the initial notice. The manager can still be opened manually or via contextual consent. Powered by URL override Override the “powered by” link in the consent modal. Leave empty to use Klaro default. https://example.com/your-link Style prefix Prefix for CSS classes/container to namespace Klaro styles. my-klaro