Klaro Releases

• The autofocus will only be enabled when using the autoFocus option.

• The title of the consent dialog is only shown when enabled through the config option showNoticeTitle.

• The previous release included source maps in the production build, which made the release binaries very large. This release fixes that.

• Fixing of a problem with the context-based consent, which caused the "Always" button to show up even if the user didn't consent / decline in the main notice yet.
• Update all packages.

• Added czech translations and improved portuguese ones.
• Removed the '...' text from the consent notice to make it easier to customize the UI.
• Added a cookiePath parameter that allows to customize the path of the Klaro cookie.

• Improved context based consent mechanism to make it less confusing for users.

• Klaro is generated as a named UMD module now to make it easier to use in environments that rely on 'require.js'.
• Better handling of SCRIPT tags without 'type' attributes.

• API configs are only being loaded if they're marked as active.

• Improved the language determination mechanism.

Fixed several small bugs affecting the contextual consent mechanism.

• Added a styling config parameter that enables the user to easily change the UI of Klaro, either by applying one or several themes to it or by defining custom CSS variables (compatible with IE11 and modern browsers).
• Fixed a bug that caused the placeholder for context-based consents to be missing.

• Fixed a problem with regular expression definition for cookie names.

• Added onAccept, onDecline and onInit event callbacks that permit to implement advanced consent mechanisms via custom Javascript code that can be dynamically loaded for a given service.
• Fixed a bug with the contextual consent mechanism that would cause the src of an iframe element to be set to undefined.

• Enabled optional HTML support for the consent modal title as well.

• Further bugfixing for context-based consent mechanism.

• Fixed a small bug in the context-based consent flow.

• Added a "test" consent store that makes testing Klaro easier and is being used e.g. in the interactive tutorials.

• Added a context-based consent mechanism that allows users to dynamically grant consent for embedded content like YouTube videos.

• Added a missing translation string.
• Improved the management of link tags by supporting the onlyOnce behavior.
• When hovering buttons the "hand" cursor will be shown.

• Fixing of a problem that cause the unstyled Klaro version to not work in combination with the API backend.

• Descriptions of services and purposes now also respect the htmlTexts parameter and can use HTML.
• 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.

• Changed the behavior of the "enable/disable all" slider for the non-grouped services view to make it consistent with the behavior for the grouped view.

• We changed the term "app" to "service" throughout the codebase. This makes the terminology coherent across the UI and codebase, as the term "service" is a better description for third-party software running on a website than "app".

Important:

The config file format changes slightly with this release. For now, old configurations will be automatically rewritten to the new format upon loading. To avoid incompatibilities in the future, we urge you to perform the following changes in the config file though:

• Change the name of the list of third-party services (formerly apps) from apps to services.
• Change the key apps to services in the translations section (only necessary if translations under this key have been overridden)

This release also changes the names of some CSS classes, so if you have overwritten the cm-apps or cm-app classes or children thereof, you need to change the class names to cm-services or cm-service, respectively.

Due to the risk of incompatibilities we decided to not tag this release with the latest tag in the CDN, to use it you'll have to upgrade manually therefore. To avoid such problems in the future, we will no longer offer a generic latest version of Klaro. Instead, we will create tags for minor versions like 0.7 that will receive regular bugfixes and improvements and can be safely used. Upgrading to new minor and major releases will be done manually, which minimizes the risk of breaking existing installations while still enabling us to deliver critical bugfixes and security updates.

• Fixed a bug that caused Klaro to not work with Internet Explorer.

• Changed the (undocumented) klaro-config-name parameter.

• Harmonization and improvement (we think) of the default translations.
• Adding of translations for a set of default processing purposes.

• Improved the initialization code to make it easier to use Klaro as a component in a JS project.

• Prepare IDE integration into the open-source version.
• Improved testing functionality.

• Changed the way the "show" event is counted.

• Changing API endpoint URLs to the new format (privacy-manager instead of consent-manager)

• Release files now include all JS and CSS files from the dist and src folder.

• When sending anonymous consent information, the ID of the consent config is sent instead of the name. This makes the consents directly attributable to a specific config version, making e.g. A/B testing easier.

• Small improvements in the event handler code.

• Fixed a problem with the anonymous consent records that prevented records being sent for the normal "accept" event.

• Improved consent records with optional saving of hostname, protocol, port and path as well as consent changes.
• Prepared deployment of the Klaro IDE (integrated development environment) that will allow easy configuration of Klaro directly on the website.

• Fixed a problem causing the cookie configuration to not work correctly.

• Added support for using an (optional) API backend to retrieve consent configs from and send anonymous consent records to.

• Add back the functionality of the hideLearnMore setting, which allows us to hide the "Learn more" link in the consent notice.
• Make it possible to show the "Learn more" link directly in the text of the consent notice.
• Improve styling of buttons for small screen widths, e.g. small mobile phones.

• Improve formatting of translation files and add information about missing translation strings.
• Include distribution files again.

• Included relevant source files in the NPM release (e.g. SCSS files) to make it easier to build on them.

• Added the language as a lang attribute to the Klaro div, to make it easier to e.g. change Klaro's style depending on the language via CSS selectors.
• Added the additionalClass option, which allows adding additional class names to the Klaro div via the config.

• Added noticeAsModal option, which will display the consent notice as a modal window, forcing the user to make a consent choice before proceeding to the page.

• Added SameSite=Lax to the Klaro cookie in order to conform to upcoming changes in cookie handling by browsers. See MDN for details.

• Fixed a problem with the klaro.resetManagers() function.
• Ensured that all attributes of a script element are copied over.

• Increased the maximum width of the consent notice to 360px to allow languages with longer translations to display the buttons without wrapping text.

• Removed the extraHTML fields from the consent modal and consent notice in favor of allowing HTML in descriptions in general. You can now set htmlTexts: true in the config, which will tell Klaro to render the translation strings you provide as HTML content. If a given string does not start with an opening bracket (<), Klaro will still put the resulting HTML/text inside a paragraph (<p>...</p>), otherwise it will render it "as is".

We hope this change will make it easier to customize the appearance of the consent notice and modal without resorting to extra config parameters. If we decide to support HTML in more places we can do that without breaking the config format again.

We apologize for introducing a breaking config change, since the extraHTML option was quite new to begin with the change should not affect many users and we think it will be beneficial in the long run.

• Added checksums to all build files generated locally, for use e.g. as subresource integrity tags. See MDN for more details about this.

• Added the groupByPurpose config option, which groups apps into categories based on their purpose, allowing the user to enable or disable entire groups of apps at once. This also reduces the space taken up by the modal, which is important especially for websites that use many third-party applications.