JavaScript Events
Für die Interaktion mit anderen Funktionalitäten der Website werden verschiedene Events zur Verfügung gestellt.
Dies bietet die Möglichkeit das Popup oder Funktionalitäten des Popups ohne Interaktion vom User zu steuern, oder Statusabfragen zu Einwilligungen abzufragen.
Grundsätzlich bieten alle Layouts die selben Events. Das bedeutet, egal ob der TCF Modus aktiviert ist oder nicht, stehen die selbe Basisfunktionalität zur Verfügung.
Nach Initialisierung des Scripts durch den Browser sind folgende Methoden via window Objekt verfügbar. Bei einigen Layouts gibt es auch die Möglichkeit, die Methoden via window.legalweb.popup Objekt aufzurufen (ohne „lw“ Prefix).
Event bei Einwilligung oder Änderung der Einwilligung
lw-optinout
Bei einem Opt-In oder Opt-Out wird ein Custom Event “lw-optinout” dispatched. Dem Event wird Folgendes als Details übergeben
- integrationId: die Id des Dienstes (google-analytics, matomo-analytics, …)
- integrationCategory: die Kategorie in welche der Dienst fällt
- integrationCode: der JS Code Base64 encoded welcher beim Opt-In ausgeführt wird
- mode: ‘optin’ oder ‘optout’
- time: new Date()
- sourceType: ‘placeholder’ oder leer wenn es das Popup ist
- sourceParentNode: wenn sourceType ‘placeholder’ dann der der Parent des Placeholders, sonst null
- sourceNode: wenn sourceType ‘placeholder’ dann der Placeholder, sonst null
Beispiel eines Bindings
window.addEventListener('lw-optinout', function (e) { console.log('optinout', e.detail); });
Events vor und nach dem Anzeigen des Popups/der Notice
lw-beforeshowpopup und lw-beforeshownotice
Vorm Anzeigen des Popups bzw. der Notice, wird das entsprechende Event ausgelöst. Mit folgendem Code kann sich auf das Event gebunden werden:
window.addEventListener('lw-beforeshowpopup', function (e) { console.log('lw-beforeshowpopup', e.detail); });
Events vor und nach Initialisieren des Popups
lw-frontendinit-start und lw-frontendinit-complete
Um herauszufinden ab welchem Zeitpunkt alles fertig initialisiert ist wird dieses Event vor Beginn und nach Ende der Initialisierung gefeuert.
Zusätzlich kann window.lwFrontendInitCompleted auf true/false geprüft werden.
Events um auf Aktionen im Popup reagieren zu können
Nachfolge Events werden immer gefeuert, wenn ein Besucher einen der Buttons zur Einwilligung oder Nicht-Einwilligung klickt.
Bei jedem Event gibt es ein start und ein complete Event
- lw-popupaction-accept-all-start
- lw-popupaction-accept-all-complete
- lw-popupaction-accept-selected-start
- lw-popupaction-accept-selected-complete
- lw-popupaction-dismiss-all-start
- lw-popupaction-dismiss-all-complete
window.addEventListener(''lw-popupaction-accept-selected-complete', function (e) { console.log('lw-popupaction-accept-selected-complete'); });