Url to the backend for accepting all (undecided) cookies.
Show "only required cookies" button in addition to the "all cookies" button.
The label text used to announce the closing of the banner by a screen reader.
An HTMLHyloAccessibilityAnnouncementElement component either as element or css query selection.
Used to announce the saving of the setup. "announcementSaved" needs to be set.
The label text used to announce the saving of the settings by a screen reader.
Classes added to the "accept all" button.
Classes added to the "accept all" button wrapped element.
Classes added to the "accept" button.
Classes added to the "accept" button wrapped element.
Classes added to the "manage" button.
Classes added to the "manage" button wrapped element.
Classes added to the "only required" button.
Classes added to the "only required" button wrapped element.
Classes added to the "save" button.
Classes added to the "save" button wrapped element.
Tries to remove cookies which are not defined by "jsonData" and accepted or required. Runs at the initialization of the component and only in banner mode.
Comma separated list of all cookie group ids which should run a frontend javascript when accepted. Javascript part does not need to be present in the frontend, so a list of just all cookie group ids works.
Url to the backend for declining all (undecided) cookies. Only needed if "onlyRequired" or "addOnlyRequired" is set.
Comma separated url snippets which disables the banner when at least one partially match the current url.
Classes added to the headline of the cookies list of a cookies group.
Classes added to the headline of a cookies group.
Property for providing the cookies information directly. Can be an array or a JSON string representing an array.
Replaces acceptLink, declineLink, jsonLink and cookieGroups but can be used as addition as well.
Structure of the array: [{ "id": string, "name": string, "description": string, "required": boolean, "cookies": [{"name": string, "domain": string, "description": string}, ...], "scripts": [string, ...] }, ...]
The first level defines the cookies groups. The "id" is the id under which the group setting is saved in the jsonDataCookie. "id" is not required for "required" groups. The "cookies" array lists all cookies belonging to the group. The "scripts" array contains all javascript code executed if the group is accepted or required. "description", "required", "cookies", "domain" and "scripts" are optional.
The scripts get only initiated if the component is not run in detail mode set by "showDetails". Example of a script which sets the hylo_media cookie: "document.cookie = "hylo_media=1; expires=Sat, 31 Jan 2099 23:00:00 GMT; path=/";"
Cookie used to save the settings of the data in the jsonData.
Url to the backend for retrieving the cookies information.
A comma separated list of cookies which should not be cleaned.
If the DjangoCMS app is used and only required cookies are defined, the required cookies have to be listed here as well.
The label of the cookies banner. Read by a screen reader.
The label of the cookies banner when in detail view. Read by a screen reader.
The label which marks the start of the cookies banner when in detail view. Read by a screen reader.
The label which marks the end of the cookies banner. Read by a screen reader.
The label which marks the start of the cookies banner. Read by a screen reader.
By default the various cookies belonging to a cookie group are not listed. This property lists the cookies.
When a choice is saved, all permitted scripts are going to be executed by creating a new script tag with the same content as the original.
When this flag is set, the scripts aren't executed and the saved changes only take effect on the next page load/change. If your page is a one-pager, it will only take effect when the user returns to or reloads the page.
If 'reload' is set as value, it reloads the page after saving.
Show "only required cookies" button instead of "all cookies" button in the banner.
Effects only when "showDetails" is set. Reloads the page when a "choice is saved". Refreshes/deactivates already activated cookie scripts. Removes/refreshes used cookies.
If not set, cookies which had been set are not removed and running scripts are not stopped.
Runs only the "jsonData" scripts. Nothing else.
Don't show as banner. Show the detail view at initialization.
Text which indicates the accepted status of a cookie group.
Text which indicates the declined status of a cookie group.
Text of the banner button which accepts all cookies.
Text of the detail view button which accepts all cookies.
Text of the banner button which accepts only required cookies.
Text of the banner button which switches to the detail view.
Text of the detail view save button.
Text which indicates the undecided status of a cookie group.
Fires when the banner got closed or did not opened at all.
Sets window["hyloCookieBannerClosed"] when the banner got closed and removed from the DOM in the process.
Fires when the banner opened.
Fires when a setting got saved and no reload is triggered.
If the component is not connected to the DOM anymore, the event is fired on the body.
Generated using TypeDoc
A cookie legal banner. Can be used in combination with the Django Cookie Consent app or as stand alone by providing jsonData. Replaces the frontend part of the Django Cookie Consent app.
If called without any attributes, it just performs a check for false-positive (only Django Cookie Consent app). It checks if a script got called even if it is disabled. If so, it cleans all set cookies. In fact, the check is performed every time, no matter whether attributes are set or not.
Sets window["hyloCookieBannerClosed"] when the banner got closed and removed from the DOM in the process.
Add style="display: none;" to the banner to reduce content shifting at page load.
Slots: