Koha/koha-tmpl/opac-tmpl/bootstrap/js/cookieconsent.js
Owen Leonard feeaa09e23
Bug 34792: Improve flexibility of CookieConsentBar layout
This patch makes CSS and markup changes to the CookieConsentBar, in both
the OPAC and staff interface, so that the layout of custom text and
buttons works better with varying text content and varying browser widths.

The patch also adds some JavaScript to the OPAC so that the cookie
consent bar interacts better with the language selection footer. When
the language selection footer is visible, the cookie consent bar should
"stick" to the bottom of the viewport except when the page is scrolled
all the way down. When the page is scrolled all the way to the bottom
the cookie consent bar should move to the top of the language selection
footer.

To test, apply the patch and rebuild the OPAC and staff interface CSS.

- Go to Administration -> System preferences and enable the
  CookieConsent preference if necessary.
- Follow the link in the preference description to HTML customizations.
- Create an HTML customization in the CookieConsentBar display location.
  Add a paragraph of text.
- Go to the OPAC. If you don't see the cookie consent bar at the bottom
  of the screen you may need to clear your browser cookies and local
  storage.
- Confirm that the text flows well in relation to the buttons: With a
  lot of text, the text expands to fill the width of the cookie consent
  bar and the buttons are below. With a small amount of text, the text
  and buttons should be side by side.
- Test that this layout adapts well to various browser widths.

- Perform the same tests in the staff interface.

Signed-off-by: Lucas Gass <lucas@bywatersolutions.com>
Signed-off-by: Katrin Fischer <katrin.fischer@bsz-bw.de>
2024-04-29 09:35:50 +02:00

220 lines
7.5 KiB
JavaScript

(function () {
// Has the user previously consented, establish our
// initial state
let selected = [];
let existingConsent = '';
// The presence of a 'cookieConsent' local storage item indicates
// that previous consent has been set. If the value is empty, then
// no consent to non-essential cookies was given
const hasStoredConsent = localStorage.getItem('cookieConsent');
getExistingConsent();
// The consent bar may not be in the DOM if it is not being used
const consentBar = $('#cookieConsentBar');
if (!consentBar) {
return;
}
if (hasStoredConsent === null) {
showConsentBar();
} else {
showYourCookies();
}
addButtonHandlers();
// When the modal is opened, populate our state based on currently
// selected values
$('#cookieConsentModal').on('shown.bs.modal', function () {
initialiseSelected();
});
$(window).on("scroll", function() {
const consentBar = $("#cookieConsentBar");
const langmenu = $("#changelanguage");
const wrapper = $("#wrapper");
if( langmenu ) {
const height = langmenu.height();
if( $(window).scrollTop() >= wrapper.offset().top + wrapper.outerHeight() - window.innerHeight ) {
consentBar.css("bottom", height);
} else {
consentBar.css("bottom", 0);
}
};
});
// Initialise existing consent based on local storage
function getExistingConsent() {
existingConsent = localStorage.getItem('cookieConsent') ?
localStorage.getItem('cookieConsent') :
[];
}
function showConsentBar() {
const consentBar = $('#cookieConsentBar');
consentBar.attr('aria-hidden', 'false');
consentBar.css("display", "flex");
}
function hideConsentBar() {
const consentBar = $('#cookieConsentBar');
consentBar.attr('aria-hidden', 'true');
consentBar.hide();
}
// Hides the appropriate consent container, depending on what
// is currently visible
function hideContainer() {
if ($('#cookieConsentModal').hasClass('show')) {
$('#cookieConsentModal').modal('hide');
} else {
hideConsentBar();
}
}
// Show the unauthenticated user's "Your cookies" button
function showYourCookies() {
// If the user is unauthenticated, there will be a
// cookieConsentsButton element in the DOM. The user
// has previously consented, so we need to display this
// button
if ($('#cookieConsentButton').length > 0) {
$('#cookieConsentDivider').show().attr('aria-hidden', 'false');
$('#cookieConsentLi').show().attr('aria-hidden', 'false');
}
}
// Initialise our state of selected item and enable/disable
// the "Accept selected" button appropriately
function initialiseSelected() {
selected = [];
$('.consentCheckbox').each(function () {
const val = $(this).val();
if (existingConsent.indexOf(val) > -1 ) {
$(this).prop('checked', true);
selected.push(val);
} else {
$(this).prop('checked', false);
}
});
enableDisableSelectedButton();
}
// Maintain our state of selected items and enable/disable
// the "Accept selected" button appropriately
function maintainSelected() {
selected = [];
$('.consentCheckbox:checked').each(function () {
selected.push($(this).val());
});
enableDisableSelectedButton();
}
// Set the enabled / disabled state of the
// "Accept selected button based on the checkbox
// states
function enableDisableSelectedButton() {
$('#consentAcceptSelected').prop(
'disabled',
selected.length === 0
);
}
function runConsentedCode() {
getExistingConsent();
$('.consentCode').each(function () {
// The user has explicitly consented to this code, or the
// code doesn't require consent in the OPAC
if (
existingConsent.indexOf($(this).data('consent-id')) > -1 ||
!$(this).data('requires-consent')
) {
const code = atob($(this).data('consent-code'));
const func = Function(code);
func();
} else {
// This code doesn't have consent to run, we may need to remove
// any cookies it has previously set
const matchPattern = $(this).data('consent-match-pattern');
const cookieDomain = $(this).data('consent-cookie-domain');
const cookiePath = $(this).data('consent-cookie-path');
if (matchPattern.length > 0) {
const regex = new RegExp(matchPattern);
const allCookies = document.cookie.split('; ');
allCookies.forEach(function (cookie) {
const name = cookie.split('=')[0];
if (regex.test(name)) {
document.cookie = name + '=; expires=Thu, 01 Jan 1970 00:00:01 GMT; domain=' + cookieDomain +'; path=' + cookiePath;
}
});
}
}
});
}
function addButtonHandlers() {
// "Accept all" handler
$('.consentAcceptAll').on('click', function(e) {
e.preventDefault();
let toSave = [];
$('.consentCheckbox').each(function () {
const val = $(this).val();
toSave.push(val);
});
localStorage.setItem('cookieConsent', toSave);
hideContainer();
runConsentedCode();
showYourCookies();
});
// "Accept essential" handler
$('.consentAcceptEssential').on('click', function(e) {
e.preventDefault();
localStorage.setItem('cookieConsent', []);
hideContainer();
runConsentedCode();
showYourCookies();
});
// "Accept selected" handler
$('#consentAcceptSelected').on('click', function(e) {
e.preventDefault();
const toSave = selected.length > 0 ? selected : [];
localStorage.setItem('cookieConsent', toSave);
hideContainer();
runConsentedCode();
showYourCookies();
});
// "Cancel" handler
$('.consentCloseModal').on('click', function(e) {
e.preventDefault();
hideContainer();
showConsentBar();
});
// "More information" handler
$('#consentMoreInfo, #cookieConsentFooter, #cookieConsentButton').on(
'click',
function (e) {
e.preventDefault();
hideConsentBar();
// Ensure we're up to date with the existing consent
getExistingConsent();
// Prevent the modal from being closed with anything
// but the buttons
$('#cookieConsentModal')
.modal({
backdrop: 'static',
keyboard: false,
focus: true,
show: true
});
}
);
$('.consentCheckbox').on('click', function () {
maintainSelected();
});
}
// On page load, run any code that has been given consent
runConsentedCode();
})();