Files

Juergen Kunz 1e74560aca fix(build): Update TypeScript config and build tooling; use accessor for Lit properties; bump deps and adjust package metadata

2025-11-30 21:22:51 +00:00

6.5 KiB

Raw Blame History

@consent.software/catalog

A sleek, modern library of web components for seamless consent management integration. Built with Lit and designed for GDPR/CCPA compliance out of the box.

Issue Reporting and Security

For reporting bugs, issues, or security vulnerabilities, please visit community.foss.global/. This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a code.foss.global/ account to submit Pull Requests directly.

Features

🍪 Cookie Consent Modal - Beautiful, responsive consent dialog with light/dark theme support 🎛️ Interactive Toggles - Draggable toggle switches with smooth animations 📱 Mobile-First Design - Fully responsive across all device sizes 🎨 Theme-Aware - Automatically detects system light/dark mode preference 🔒 Privacy-First - Integrates with consent.software backend for compliant consent tracking ⚡ Zero Config - Drop-in components that just work

Installation

npm install @consent.software/catalog
# or
pnpm add @consent.software/catalog

Quick Start

Import the components and add the consent banner to your page:

import '@consent.software/catalog';

// That's it! Add the component to your HTML

<consentsoftware-cookieconsent></consentsoftware-cookieconsent>

The consent banner automatically:

Shows on first visit when no consent preferences are stored
Hides after user makes a selection
Respects system dark/light mode
Stores preferences via the consent.software backend

Components

`<consentsoftware-cookieconsent>`

The main consent modal component. Provides a full-screen overlay with cookie preference options.

<consentsoftware-cookieconsent></consentsoftware-cookieconsent>

Features:

Three-button interface: Deny, Accept Selection, Accept All
Four cookie categories: Required, Preferences, Statistics, Marketing
Animated modal with backdrop blur
Shake feedback when clicking outside the modal
Automatic theme detection (light/dark)

`<consentsoftware-toggle>`

A draggable toggle switch component with touch support.

<consentsoftware-toggle>Label Text</consentsoftware-toggle>
<consentsoftware-toggle required>Required</consentsoftware-toggle>

Properties:

required (boolean) - When true, toggle is locked in the "on" position
selected (boolean) - Current toggle state

Events:

toggle - Fired when state changes, includes { selected: boolean } in detail

`<consentsoftware-tabs>`

Tab navigation component with animated indicator.

<consentsoftware-tabs></consentsoftware-tabs>

Displays three tabs: Consent, Details, and Cookie Policy.

`<consentsoftware-header>`

Simple header component for the consent modal.

<consentsoftware-header></consentsoftware-header>

`<consentsoftware-mainselection>`

Grid layout containing toggle switches for each cookie category.

<consentsoftware-mainselection></consentsoftware-mainselection>

Backend Integration

This catalog integrates with the @consent.software/webclient package for backend communication:

import { CsWebclient } from '@consent.software/webclient';

const client = new CsWebclient();

// Check current consent levels
const levels = await client.getCookieLevels();
if (!levels) {
  // Show consent dialog
}

// Set consent levels programmatically
await client.setCookieLevels(['functional', 'analytics']);

// Run consent-dependent scripts
await client.getAndRunConsentTuples();

Styling & Theming

The components use CSS custom properties for easy theming:

consentsoftware-cookieconsent {
  /* Text and colors */
  --text-color: #333;
  --background-color: #eeeeee;
  --accent-color: #333333;

  /* Buttons */
  --button-bg: #ffffff;
  --button-hover-bg: #f2f2f2;

  /* Links */
  --link-color: #333;
  --icon-color: #4496f5;

  /* Modal */
  --modal-box-shadow: 0px 0px 8px rgba(0, 0, 0, 0.2);
  --info-bg: rgba(0, 0, 0, 0.1);
  --info-text: rgba(0, 0, 0, 0.5);
}

The component automatically switches to dark theme variables when theme="dark" is set or when the system prefers dark mode.

The consent system uses three user-selectable levels plus a required baseline:

Level	Description
`functional`	Required cookies for site operation (always enabled)
`preferences`	User preference cookies
`analytics`	Statistics and analytics tracking
`marketing`	Marketing and advertising cookies

Browser Support

Chrome (last 2 versions)
Firefox (last 2 versions)
Safari (last 2 versions)
Edge (last 2 versions)

Built with modern ES modules and requires browsers with native Custom Elements v1 support.

Development

# Install dependencies
pnpm install

# Build the project
pnpm run build

# Watch mode for development
pnpm run watch

License and Legal Information

This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the LICENSE file.

Please note: The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.

Trademarks

This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.

Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.

6.5 KiB Raw Blame History