BREAKING CHANGE(elements): Migrate web components to @design.estate/dees-element, introduce shared theme colors and cssManager, and update imports/usages across ts_web.

This commit is contained in:
2025-11-30 21:54:10 +00:00
parent 0b366b360d
commit 0d90a7ae7f
11 changed files with 428 additions and 486 deletions

View File

@@ -1,8 +1,13 @@
import * as shared from './shared.js';
import { cssManager, colors } from './shared.js';
import { LitElement, html, css, type TemplateResult } from 'lit';
import { customElement } from 'lit/decorators.js';
import { property } from 'lit/decorators/property.js';
import {
DeesElement,
customElement,
html,
css,
type TemplateResult,
property,
} from '@design.estate/dees-element';
import * as csInterfaces from '@consent.software/interfaces';
import * as csWebclient from '@consent.software/webclient';
@@ -15,212 +20,158 @@ declare global {
}
@customElement('consentsoftware-cookieconsent')
export class ConsentsoftwareCookieconsent extends LitElement {
export class ConsentsoftwareCookieconsent extends DeesElement {
public static demo = () => html`<consentsoftware-cookieconsent></consentsoftware-cookieconsent>`;
public csWebclientInstance = new csWebclient.CsWebclient();
public csWebclientRan = false;
// Reflects the current theme ('light' or 'dark')
@property({ type: String, reflect: true })
public accessor theme: 'light' | 'dark' = 'light';
public static styles = [
cssManager.defaultStyles,
css`
:host {
font-size: 14px;
user-select: none;
}
/**
* 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};
font-size: 14px;
user-select: none;
/* Shadcn-inspired Dark Theme (default) */
--background: hsl(0 0% 7%);
--foreground: hsl(0 0% 95%);
--muted: hsl(0 0% 15%);
--muted-foreground: hsl(0 0% 64%);
--border: hsl(0 0% 18%);
--input: hsl(0 0% 15%);
--primary: hsl(0 0% 98%);
--primary-foreground: hsl(0 0% 9%);
--secondary: hsl(0 0% 15%);
--secondary-foreground: hsl(0 0% 98%);
--accent: hsl(0 0% 15%);
--accent-foreground: hsl(0 0% 98%);
--ring: hsl(0 0% 30%);
--radius: 8px;
}
.pageOverlay {
position: fixed;
inset: 0;
display: grid;
align-items: center;
justify-content: center;
z-index: 1000;
background: rgba(0, 0, 0, 0);
backdrop-filter: blur(0px);
transition: all 0.2s ease-out;
}
:host([theme='dark']) {
--background: hsl(0 0% 7%);
--foreground: hsl(0 0% 95%);
--muted: hsl(0 0% 15%);
--muted-foreground: hsl(0 0% 64%);
--border: hsl(0 0% 18%);
--input: hsl(0 0% 15%);
--primary: hsl(0 0% 98%);
--primary-foreground: hsl(0 0% 9%);
--secondary: hsl(0 0% 15%);
--secondary-foreground: hsl(0 0% 98%);
--accent: hsl(0 0% 15%);
--accent-foreground: hsl(0 0% 98%);
--ring: hsl(0 0% 30%);
}
.pageOverlay.shake {
background: rgba(0, 0, 0, 0.6) !important;
}
:host([theme='light']) {
--background: hsl(0 0% 100%);
--foreground: hsl(0 0% 9%);
--muted: hsl(0 0% 96%);
--muted-foreground: hsl(0 0% 45%);
--border: hsl(0 0% 90%);
--input: hsl(0 0% 90%);
--primary: hsl(0 0% 9%);
--primary-foreground: hsl(0 0% 98%);
--secondary: hsl(0 0% 96%);
--secondary-foreground: hsl(0 0% 9%);
--accent: hsl(0 0% 96%);
--accent-foreground: hsl(0 0% 9%);
--ring: hsl(0 0% 64%);
}
.pageOverlay {
position: fixed;
inset: 0;
display: grid;
align-items: center;
justify-content: center;
z-index: 1000;
background: rgba(0, 0, 0, 0);
backdrop-filter: blur(0px);
transition: all 0.2s ease-out;
}
.pageOverlay.shake {
background: rgba(0, 0, 0, 0.6) !important;
}
.modalBox {
display: block;
color: var(--foreground);
background: var(--background);
box-shadow:
0 0 0 1px var(--border),
0 16px 70px rgba(0, 0, 0, 0.35);
position: relative;
border-radius: var(--radius);
max-width: 520px;
min-width: 320px;
box-sizing: border-box;
overflow: hidden;
will-change: transform;
transition: all 0.2s ease-out;
transform: scale(0.96);
opacity: 0;
}
@media (max-width: 560px) {
.modalBox {
max-width: 100%;
min-width: 100%;
height: 100vh;
border-radius: 0;
display: block;
color: ${cssManager.bdTheme(colors.light.foreground, colors.dark.foreground)};
background: ${cssManager.bdTheme(colors.light.background, colors.dark.background)};
box-shadow:
0 0 0 1px ${cssManager.bdTheme(colors.light.border, colors.dark.border)},
0 16px 70px ${cssManager.bdTheme('rgba(0, 0, 0, 0.15)', 'rgba(0, 0, 0, 0.35)')};
position: relative;
border-radius: 8px;
max-width: 520px;
min-width: 320px;
box-sizing: border-box;
overflow: hidden;
will-change: transform;
transition: all 0.2s ease-out;
transform: scale(0.96);
opacity: 0;
}
}
.modalBox.shake {
animation: shake 120ms 2 linear;
}
@media (max-width: 560px) {
.modalBox {
max-width: 100%;
min-width: 100%;
height: 100vh;
border-radius: 0;
}
}
@keyframes shake {
0% { transform: translateX(3px); }
50% { transform: translateX(-3px); }
100% { transform: translateX(0); }
}
.modalBox.shake {
animation: shake 120ms 2 linear;
}
:host([show='false']) { display: none; }
:host([show='true']) { display: block; }
@keyframes shake {
0% { transform: translateX(3px); }
50% { transform: translateX(-3px); }
100% { transform: translateX(0); }
}
.content {
margin: auto;
}
:host([show='false']) { display: none; }
:host([show='true']) { display: block; }
.text-container {
padding: 12px 16px;
font-size: 0.9em;
line-height: 1.5;
color: var(--muted-foreground);
}
.content {
margin: auto;
}
.text-container a {
color: var(--foreground);
text-decoration: underline;
text-underline-offset: 2px;
}
.text-container {
padding: 12px 16px;
font-size: 0.9em;
line-height: 1.5;
color: ${cssManager.bdTheme(colors.light.mutedForeground, colors.dark.mutedForeground)};
}
.text-container a:hover {
opacity: 0.8;
}
.text-container a {
color: ${cssManager.bdTheme(colors.light.foreground, colors.dark.foreground)};
text-decoration: underline;
text-underline-offset: 2px;
}
.button-container {
padding: 12px 16px 16px;
display: grid;
grid-template-columns: repeat(3, 1fr);
gap: 8px;
}
.text-container a:hover {
opacity: 0.8;
}
@media (max-width: 560px) {
.button-container {
grid-template-columns: 1fr;
padding: 12px 16px 16px;
display: grid;
grid-template-columns: repeat(3, 1fr);
gap: 8px;
}
}
.consent-button {
border-radius: calc(var(--radius) - 2px);
background: var(--secondary);
border: 1px solid var(--border);
padding: 8px 16px;
font-size: 0.85em;
font-weight: 500;
text-align: center;
cursor: pointer;
transition: all 0.15s ease;
color: var(--secondary-foreground);
}
@media (max-width: 560px) {
.button-container {
grid-template-columns: 1fr;
}
}
.consent-button:hover {
background: var(--accent);
border-color: var(--ring);
}
.consent-button {
border-radius: 6px;
background: ${cssManager.bdTheme(colors.light.secondary, colors.dark.secondary)};
border: 1px solid ${cssManager.bdTheme(colors.light.border, colors.dark.border)};
padding: 8px 16px;
font-size: 0.85em;
font-weight: 500;
text-align: center;
cursor: pointer;
transition: all 0.15s ease;
color: ${cssManager.bdTheme(colors.light.secondaryForeground, colors.dark.secondaryForeground)};
}
.consent-button:last-child {
background: var(--primary);
color: var(--primary-foreground);
border-color: var(--primary);
}
.consent-button:hover {
background: ${cssManager.bdTheme(colors.light.accent, colors.dark.accent)};
border-color: ${cssManager.bdTheme(colors.light.ring, colors.dark.ring)};
}
.consent-button:last-child:hover {
opacity: 0.9;
}
.consent-button:last-child {
background: ${cssManager.bdTheme(colors.light.primary, colors.dark.primary)};
color: ${cssManager.bdTheme(colors.light.primaryForeground, colors.dark.primaryForeground)};
border-color: ${cssManager.bdTheme(colors.light.primary, colors.dark.primary)};
}
.info-container {
text-align: center;
padding: 10px 16px;
background: var(--muted);
border-top: 1px solid var(--border);
font-size: 0.75em;
color: var(--muted-foreground);
}
.consent-button:last-child:hover {
opacity: 0.9;
}
.info-container a {
color: var(--foreground);
text-decoration: none;
}
.info-container {
text-align: center;
padding: 10px 16px;
background: ${cssManager.bdTheme(colors.light.muted, colors.dark.muted)};
border-top: 1px solid ${cssManager.bdTheme(colors.light.border, colors.dark.border)};
font-size: 0.75em;
color: ${cssManager.bdTheme(colors.light.mutedForeground, colors.dark.mutedForeground)};
}
.info-container a:hover {
text-decoration: underline;
}
`;
.info-container a {
color: ${cssManager.bdTheme(colors.light.foreground, colors.dark.foreground)};
text-decoration: none;
}
.info-container a:hover {
text-decoration: underline;
}
`,
];
constructor() {
super();
@@ -278,18 +229,17 @@ export class ConsentsoftwareCookieconsent extends LitElement {
/**
* 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.
* Displays the consent banner if no cookie levels are set.
*/
public async connectedCallback() {
super.connectedCallback();
this.updateTheme(); // Initialize theme based on system preference
await super.connectedCallback();
const cookieLevel = await this.csWebclientInstance.getCookieLevels();
if (!cookieLevel) {
// Show consent banner if cookie levels haven't been set yet
this.setAttribute('show', 'true');
requestAnimationFrame(async () => {
await this.updated();
await this.updateComplete;
const pageOverlay: HTMLDivElement = this.shadowRoot?.querySelector('.pageOverlay');
if (pageOverlay) {
// Apply subtle backdrop blur when modal appears
@@ -310,14 +260,7 @@ export class ConsentsoftwareCookieconsent extends LitElement {
}
public async firstUpdated() {
// Placeholder for any logic needed after first render
}
/**
* 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`);
// Run consent scripts if levels are already set
const acceptedCookieLevels = await this.csWebclientInstance.getCookieLevels();
if (!this.csWebclientRan && acceptedCookieLevels) {
this.csWebclientRan = true;
@@ -327,7 +270,6 @@ export class ConsentsoftwareCookieconsent extends LitElement {
/**
* Handles consent button clicks, sets cookie levels, and hides the banner.
* Uses theme variables for styling transitions.
*/
private async handleConsentButtonClick(
event: MouseEvent,
@@ -349,7 +291,12 @@ export class ConsentsoftwareCookieconsent extends LitElement {
await this.csWebclientInstance.setCookieLevels(levelsArg);
await delayFor(300);
this.setAttribute('show', 'false'); // Hide the consent banner
this.updated(); // Trigger any post-consent actions
// Run consent scripts
if (!this.csWebclientRan) {
this.csWebclientRan = true;
await this.csWebclientInstance.getAndRunConsentTuples();
}
}
/**
@@ -369,19 +316,4 @@ export class ConsentsoftwareCookieconsent extends LitElement {
}
}
}
/**
* 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';
});
}
}