Compare commits

..

14 Commits

6 changed files with 216 additions and 119 deletions

View File

@ -1,5 +1,50 @@
# Changelog
## 2025-01-22 - 1.6.0 - feat(elements)
Enhance theme handling and CSS organization for consent component
- Introduced theme-specific CSS variables for better theming support in consentsoftware-cookieconsent.
- Reorganized styles in consentsoftware-cookieconsent for cleaner look and consistency.
- Added media queries for responsive design in consentsoftware-tabs.
## 2025-01-21 - 1.5.4 - fix(consentsoftware-components)
Add interactive consent software components for managing cookie levels.
- Implemented 'consentsoftware-cookieconsent' component for cookie management
- Introduced 'consentsoftware-toggle' for user interaction improvements
- Added theme support for light/dark modes in consent components
- Enhanced consent interface with responsive design and accessibility features
## 2025-01-20 - 1.5.3 - fix(consentsoftware-cookieconsent)
Fix visual inconsistencies in the consent software modal overlay and shadow.
- Updated the shadow color in the modal box to use a consistent color.
- Restored backdrop blur effect in the page overlay when visible.
## 2025-01-20 - 1.5.2 - fix(core)
No changes detected
## 2025-01-20 - 1.5.1 - fix(consentsoftware-cookieconsent)
Adjusted shake animation duration and box-shadow for modalBox in consent cookie component.
- Changed the box-shadow to be softer with reduced spread for more subtle visual effect.
- Increased the duration of shake animation from 300ms to 2000ms for enhanced user feedback upon overlay interaction.
## 2025-01-20 - 1.5.0 - feat(consentsoftware-cookieconsent)
Enhance consent modal with shake animation on overlay click
- Added shake animation to the modal and overlay when clicked outside the modal.
- Updated dependency @consent.software/interfaces to version ^1.0.14.
## 2025-01-17 - 1.4.5 - fix(elements)
Fix issues in consentsoftware-cookieconsent component
- Removed unused attribute handling for 'gotIt'.
- Fixed background and backdrop-filter transitions to ensure proper UI behavior.
- Consolidated consent button click handling into handleConsentButtonClick.
- Improved modal visibility toggling and acceptance flow.
## 2025-01-17 - 1.4.4 - fix(core)
Update LitElement properties to use accessors

View File

@ -1,6 +1,6 @@
{
"name": "@consent.software/catalog",
"version": "1.4.4",
"version": "1.6.0",
"private": false,
"description": "A library of web components designed to integrate robust consent management capabilities into web applications, ensuring compliance with privacy regulations.",
"exports": {
@ -15,7 +15,7 @@
"author": "Lossless GmbH",
"license": "MIT",
"dependencies": {
"@consent.software/interfaces": "^1.0.11",
"@consent.software/interfaces": "^1.0.14",
"@consent.software/webclient": "^1.1.0",
"@push.rocks/smartdelay": "^3.0.5",
"lit": "^3.2.1"

19
pnpm-lock.yaml generated
View File

@ -9,8 +9,8 @@ importers:
.:
dependencies:
'@consent.software/interfaces':
specifier: ^1.0.11
version: 1.0.13
specifier: ^1.0.14
version: 1.0.14
'@consent.software/webclient':
specifier: ^1.1.0
version: 1.1.0
@ -42,9 +42,6 @@ packages:
'@api.global/typedrequest-interfaces@2.0.2':
resolution: {integrity: sha512-D+mkr4IiUZ/eUgrdp5jXjBKOW/iuMcl0z2ZLQsLLypKX/psFGD3viZJ58FNRa+/1OSM38JS5wFyoWl8oPEFLrw==}
'@api.global/typedrequest-interfaces@3.0.1':
resolution: {integrity: sha512-eR2Cr01BYRwIq/X2ajOenWhm8l+/YE4A5kK/9V6I8ZnhtEBMFHG6YjF6Fg8npLJWbvhZXhOms+axZ6JKI71o8g==}
'@api.global/typedrequest-interfaces@3.0.19':
resolution: {integrity: sha512-uuHUXJeOy/inWSDrwD0Cwax2rovpxYllDhM2RWh+6mVpQuNmZ3uw6IVg6dA2G1rOe24Ebs+Y9SzEogo+jYN7vw==}
@ -227,8 +224,8 @@ packages:
'@cloudflare/workers-types@4.20241230.0':
resolution: {integrity: sha512-dtLD4jY35Lb750cCVyO1i/eIfdZJg2Z0i+B1RYX6BVeRPlgaHx/H18ImKAkYmy0g09Ow8R2jZy3hIxMgXun0WQ==}
'@consent.software/interfaces@1.0.13':
resolution: {integrity: sha512-xB1h5n5vltRLBrvQhrKz4K6tz+TN5RHHvcbQbTIphxetiWOJJq/RwyEN2iH8TtwWIGBSqHRtoljBQqY8t8Oanw==}
'@consent.software/interfaces@1.0.14':
resolution: {integrity: sha512-xfOhDuj4ECEMyutJCSwEOX1SPN/MlReR40D/x7CsKg1mSauoq0pZbZEUb9m4z5EoPfywZl8gkLVzFoiGyg1IcA==}
'@consent.software/webclient@1.1.0':
resolution: {integrity: sha512-VX7e8ygZwgU8WEzn22fdvvEytLYl4kfp/u40GusaBU4iFtjrCY2hxDy9Z1FTKicpGcRxf3t13lM0Jaugq7Jj/w==}
@ -2981,8 +2978,6 @@ snapshots:
'@api.global/typedrequest-interfaces@2.0.2': {}
'@api.global/typedrequest-interfaces@3.0.1': {}
'@api.global/typedrequest-interfaces@3.0.19': {}
'@api.global/typedrequest@3.1.10':
@ -3569,14 +3564,14 @@ snapshots:
'@cloudflare/workers-types@4.20241230.0': {}
'@consent.software/interfaces@1.0.13':
'@consent.software/interfaces@1.0.14':
dependencies:
'@api.global/typedrequest-interfaces': 3.0.1
'@api.global/typedrequest-interfaces': 3.0.19
'@consent.software/webclient@1.1.0':
dependencies:
'@api.global/typedrequest': 3.1.10
'@consent.software/interfaces': 1.0.13
'@consent.software/interfaces': 1.0.14
'@push.rocks/smarttime': 4.1.1
'@push.rocks/webstore': 2.0.20

View File

@ -3,6 +3,6 @@
*/
export const commitinfo = {
name: '@consent.software/catalog',
version: '1.4.4',
version: '1.6.0',
description: 'A library of web components designed to integrate robust consent management capabilities into web applications, ensuring compliance with privacy regulations.'
}

View File

@ -21,18 +21,20 @@ export class ConsentsoftwareCookieconsent extends LitElement {
public csWebclientInstance = new csWebclient.CsWebclient();
public csWebclientRan = false;
// Reflects the current theme ('light' or 'dark')
@property({ type: String, reflect: true })
public theme: 'light' | 'dark' = 'light';
/**
* We bind `heightPixels` to a CSS variable (--cookieconsent-height).
* Then we can do margin-bottom animations in CSS.
* Define component styles with CSS variables that adjust based on theme.
* The default variables serve as baseline for the light theme.
* Theme-specific overrides modify these for dark mode.
*/
public static styles = css`
:host {
font-family: ${shared.fontStack};
user-select: none;
/* Default theme variables */
/* Default variables for Light Theme */
--text-color: #333;
--background-color: #eeeeee;
--accent-color: #333333;
@ -41,8 +43,14 @@ export class ConsentsoftwareCookieconsent extends LitElement {
--icon-color: #4496f5;
--link-color: #333;
--padding-sides: 16px;
/* Additional variables for modal and info container styling */
--info-bg: rgba(0, 0, 0, 0.1);
--info-text: rgba(255, 255, 255, 0.5);
--modal-box-shadow: 0px 0px 8px rgba(0, 0, 0, 0.2);
}
/* Dark Theme Overrides:
When theme attribute is 'dark', override variables accordingly. */
:host([theme='dark']) {
--text-color: #fff;
--background-color: #111;
@ -51,8 +59,14 @@ export class ConsentsoftwareCookieconsent extends LitElement {
--button-hover-bg: #222222;
--icon-color: #4496f5;
--link-color: #fff;
--info-bg: rgba(0, 0, 0, 0.1);
--info-text: rgba(255, 255, 255, 0.5);
--modal-box-shadow: 0px 0px 8px rgba(255, 255, 255, 0.6);
}
/* Light Theme Overrides:
Explicit light theme settings, currently matching defaults.
Can be customized independently if desired. */
:host([theme='light']) {
--text-color: #333;
--background-color: #eeeeee;
@ -61,29 +75,39 @@ export class ConsentsoftwareCookieconsent extends LitElement {
--button-hover-bg: #f2f2f2;
--icon-color: #4496f5;
--link-color: #333;
--info-bg: rgba(0, 0, 0, 0.1);
--info-text: rgba(0, 0, 0, 0.5);
--modal-box-shadow: 0px 0px 8px rgba(0, 0, 0, 0.2);
}
/* Overlay covering the page behind the modal */
.pageOverlay {
position: fixed;
top: 0px;
bottom: 0px;
right: 0px;
left: 0px;
top: 0;
bottom: 0;
right: 0;
left: 0;
display: grid;
align-items: center;
justify-content: center;
z-index: 1000; /* standard z-index for fixed elements */
background: rgba(0, 0, 0, 0);
z-index: 1000; /* Ensures the overlay is on top of other elements */
background: rgba(255, 255, 255, 0);
backdrop-filter: blur(0px);
transition: all 0.2s;
}
/* Shake animation for overlay when clicked */
.pageOverlay.shake {
background: rgba(0, 0, 0, 0.5) !important;
}
/* Modal box styling using theme variables for colors and shadows */
.modalBox {
display: block;
color: var(--text-color);
background: var(--background-color);
box-shadow: 0px 0px 15px rgba(0, 0, 0, 0.6);
position: realtive;
box-shadow: var(--modal-box-shadow);
position: relative;
border: 1px dotted rgba(255, 255, 255, 0.1);
border-top: 1px solid var(--accent-color);
border-radius: 16px;
@ -91,20 +115,39 @@ export class ConsentsoftwareCookieconsent extends LitElement {
min-width: calc(100vw / 3);
box-sizing: border-box;
overflow: hidden;
/*
* We start with margin-bottom as negative to hide the banner.
* The animation occurs when we toggle the gotIt/show attributes.
*/
will-change: transform; /* ensure efficient rendering */
will-change: transform;
transition: all 0.3s;
transform: scale(0.95);
opacity: 0;
}
/*
* Toggle display based on [show] attribute
* (so if show=false, the banner doesn't show at all).
*/
/* Media query for mobile devices: stack buttons vertically */
@media (max-width: 600px) {
.modalBox {
height: 100vh;
box-shadow: none;
border-radius: 0px;
}
}
/* Shake animation for modal box */
.modalBox.shake {
animation: shake 150ms 2 linear;
}
@keyframes shake {
0% {
transform: translate(3px, 0);
}
50% {
transform: translate(-3px, 0);
}
100% {
transform: translate(0, 0);
}
}
/* Toggle display based on [show] attribute */
:host([show='false']) {
display: none;
}
@ -112,18 +155,6 @@ export class ConsentsoftwareCookieconsent extends LitElement {
display: block;
}
/*
* Animate margin-bottom when [gotIt] toggles.
* If gotIt=true, push the banner down off-screen.
* If gotIt=false, pull the banner into view.
*/
:host([gotIt='true']) {
background: blue;
}
:host([gotIt='false']) {
background: red;
}
.content {
margin: auto;
}
@ -147,25 +178,14 @@ export class ConsentsoftwareCookieconsent extends LitElement {
gap: 16px;
}
.info-container {
color: var(--text-color);
text-align: center;
line-height: 3em;
background: rgba(0, 0, 0, 0.1);
border-top: 1px dotted rgba(255, 255, 255, 0.1);
font-size: 0.8em;
color: rgba(255, 255, 255, 0.5);
}
.info-container a {
text-decoration: underline;
color: var(--link-color);
transition: color 0.2s;
}
.info-container a:hover {
color: #ffffff;
/* Media query for mobile devices: stack buttons vertically */
@media (max-width: 600px) {
.button-container {
grid-template-columns: 1fr;
}
}
/* Consent button styling using theme variables */
.consent-button {
border-radius: 3px;
background: var(--button-bg);
@ -180,17 +200,36 @@ export class ConsentsoftwareCookieconsent extends LitElement {
.consent-button:hover {
background: var(--button-hover-bg);
}
/* Use theme variables for info container background and text */
.info-container {
text-align: center;
line-height: 3em;
background: var(--info-bg);
border-top: 1px dotted rgba(255, 255, 255, 0.1);
font-size: 0.8em;
color: var(--info-text);
}
.info-container a {
text-decoration: underline;
color: var(--link-color);
transition: color 0.2s;
}
.info-container a:hover {
color: #ffffff;
}
`;
constructor() {
super();
this.setAttribute('gotIt', 'true');
// Initially hide the consent banner until needed
this.setAttribute('show', 'false');
}
public render(): TemplateResult {
return html`
<div class="pageOverlay">
<div class="pageOverlay" @click=${this.pageOverlayClick}>
<div class="modalBox">
<div class="content">
<consentsoftware-header></consentsoftware-header>
@ -202,52 +241,26 @@ export class ConsentsoftwareCookieconsent extends LitElement {
and choose which cookie level you are willing to accept.
</div>
</div>
<!-- <div class="button-container">
<div
class="consent-button"
@click=${(event: MouseEvent) => this.setLevel(event, ['functional'])}
>
Functional cookies
</div>
<div
class="consent-button"
@click=${(event: MouseEvent) => this.setLevel(event, ['functional', 'analytics'])}
>
Analytics cookies
</div>
<div
class="consent-button"
@click=${(event: MouseEvent) =>
this.setLevel(event, ['functional', 'analytics', 'marketing'])}
>
Marketing cookies
</div>
<div
class="consent-button"
@click=${(event: MouseEvent) =>
this.setLevel(event, ['functional', 'analytics', 'marketing', 'all'])}
>
All cookies
</div>
</div> -->
<consentsoftware-mainselection></consentsoftware-mainselection>
<div class="button-container">
<div
class="consent-button"
@click=${(event: MouseEvent) => this.setLevel(event, ['functional'])}
@click=${(event: MouseEvent) =>
this.handleConsentButtonClick(event, ['functional'])}
>
Deny
</div>
<div
class="consent-button"
@click=${(event: MouseEvent) => this.setLevel(event, ['functional', 'analytics'])}
@click=${(event: MouseEvent) =>
this.handleConsentButtonClick(event, ['functional', 'analytics'])}
>
Accept selection
</div>
<div
class="consent-button"
@click=${(event: MouseEvent) =>
this.setLevel(event, ['functional', 'analytics', 'marketing'])}
this.handleConsentButtonClick(event, ['functional', 'analytics', 'marketing'])}
>
Accept all cookies
</div>
@ -263,43 +276,44 @@ export class ConsentsoftwareCookieconsent extends LitElement {
}
/**
* Called when the element is inserted into the DOM.
* Lifecycle method called when the element is connected to the DOM.
* It sets up the theme and displays the consent banner if no cookie levels are set.
*/
public async connectedCallback() {
super.connectedCallback();
this.updateTheme();
this.updateTheme(); // Initialize theme based on system preference
const cookieLevel = await this.csWebclientInstance.getCookieLevels();
if (!cookieLevel) {
// Show consent banner if cookie levels haven't been set yet
this.setAttribute('show', 'true');
this.setAttribute('gotIt', 'false');
requestAnimationFrame(async () => {
await this.updated();
const pageOverlay: HTMLDivElement = this.shadowRoot?.querySelector('.pageOverlay');
if (pageOverlay) {
pageOverlay.style.background = 'rgba(0, 0, 0, 0.1)';
pageOverlay.style.backdropFilter = 'blur(2px)';
// Apply dark overlay styling when modal appears
pageOverlay.style.background = 'rgba(0,0,0, 0.5)';
pageOverlay.style.backdropFilter = 'blur(20px)';
}
const modalBox: HTMLDivElement = this.shadowRoot?.querySelector('.modalBox');
if (modalBox) {
// Animate modal box appearance
modalBox.style.transform = `scale(1)`;
modalBox.style.opacity = '1';
}
});
} else {
// Hide banner if cookie levels are already set
this.setAttribute('show', 'false');
this.setAttribute('gotIt', 'true');
}
}
/**
* Called after the first render of the component.
* We measure the actual height of the banner and update the CSS variable.
*/
public async firstUpdated() {}
public async firstUpdated() {
// Placeholder for any logic needed after first render
}
/**
* Called whenever the element is updated or re-rendered.
* Called after updates. Logs banner height and runs consent scripts if necessary.
*/
public async updated() {
console.log(`The height of the cookie banner is ${this.shadowRoot?.host?.clientHeight}px`);
@ -311,25 +325,61 @@ export class ConsentsoftwareCookieconsent extends LitElement {
}
/**
* Sets the users chosen cookie level(s) and hides the banner.
* Handles consent button clicks, sets cookie levels, and hides the banner.
* Uses theme variables for styling transitions.
*/
private async setLevel(event: MouseEvent, levelsArg: csInterfaces.TCookieLevel[]) {
private async handleConsentButtonClick(
event: MouseEvent,
levelsArg: csInterfaces.TCookieLevel[]
) {
console.log(`Set level to ${levelsArg}`);
const pageOverlay: HTMLDivElement = this.shadowRoot?.querySelector('.pageOverlay');
if (pageOverlay) {
// Fade out overlay effect using inline styles for transition
pageOverlay.style.background = 'rgba(255,255,255, 0)';
pageOverlay.style.backdropFilter = 'blur(0px)';
}
const modalBox: HTMLDivElement = this.shadowRoot?.querySelector('.modalBox');
if (modalBox) {
// Scale down and fade out modal box before hiding
modalBox.style.transform = `scale(0.95)`;
modalBox.style.opacity = '0';
}
// Save user consent preferences
await this.csWebclientInstance.setCookieLevels(levelsArg);
this.setAttribute('gotIt', 'true');
await delayFor(300);
this.setAttribute('show', 'false');
// After user selection, re-check for any required scripts to run
this.updated();
this.setAttribute('show', 'false'); // Hide the consent banner
this.updated(); // Trigger any post-consent actions
}
/**
* Dynamically switches the theme between light/dark,
* respecting `prefers-color-scheme` by default.
* Handles clicks on the page overlay. If clicked outside the modal,
* triggers a shake animation as feedback.
*/
private async pageOverlayClick(e: MouseEvent) {
if (e.target === e.currentTarget) {
const pageOverlay: HTMLDivElement = this.shadowRoot?.querySelector('.pageOverlay');
const modalBox: HTMLDivElement = this.shadowRoot?.querySelector('.modalBox');
if (pageOverlay && modalBox) {
pageOverlay.classList.add('shake');
modalBox.classList.add('shake');
await delayFor(2000);
pageOverlay.classList.remove('shake');
modalBox.classList.remove('shake');
}
}
}
/**
* Dynamically switches the theme between light and dark.
* Listens for system theme changes to update the component's theme.
*/
private updateTheme() {
// Check the initial system preference for dark mode
const prefersDark = window.matchMedia('(prefers-color-scheme: dark)').matches;
this.theme = prefersDark ? 'dark' : 'light';
// Listen for changes in the system color scheme preference
window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', (e) => {
this.theme = e.matches ? 'dark' : 'light';
});

View File

@ -24,6 +24,13 @@ export class ConsentsoftwareTabs extends LitElement {
cursor: pointer;
}
/* Media query for mobile devices: stack buttons vertically */
@media (max-width: 600px) {
.tabs .tab {
font-size: 0.8em;
}
}
.selector {
position: absolute;
width: calc(100% / 3);
@ -44,7 +51,7 @@ export class ConsentsoftwareTabs extends LitElement {
<div class="tabs">
<div class="tab" @click=${this.handleClick}>Consent</div>
<div class="tab" @click=${this.handleClick}>Details</div>
<div class="tab" @click=${this.handleClick}>Cookie Policy + Legal Info</div>
<div class="tab" @click=${this.handleClick}>Cookie Policy</div>
</div>
<div class="selector"></div>
`;
@ -61,4 +68,4 @@ export class ConsentsoftwareTabs extends LitElement {
}
}
}
}
}