Skip to content
UI Brok

Loading…

No results

Browse catalog

Consent Manager

A client-only GDPR cookie-consent banner with per-category switches that persist to localStorage.

Preview

We value your privacy

We use cookies to enhance your browsing experience, serve personalised content, and analyse our traffic. You can choose which categories to allow.

Controls

Theme
Surface
Direction
Viewport

Device view renders in an isolated frame so real responsive breakpoints apply. Switch to Full for overflowing popovers.

Installation

terminal
php artisan ui:add consent-manager

Behavior layer (Alpine)

This component installs a self-registering Alpine module to resources/js/ui/consent-manager.js. Import the behavior layer once from your bundle so it loads (it hooks alpine:init):

resources/js/ui/index.js JS
import './consent-manager.js';

Registry contract

Install confidence

php artisan ui:add consent-manager writes only the generated targets below. The CLI validates each file hash before writing and prompts before replacing local changes unless --force is used.

Version
1.0.0
License
open
Stability
stable
Contract
v2
Foundation
≥ 1.0.0
Type Generated target
blade resources/views/components/ui/consent-manager.blade.php
js resources/js/ui/consent-manager.js

Registry dependencies

card button switch label separator

Package dependencies

composer: jml/brok:^1.0

npm: alpinejs

Guidance

Focused overlay

Handle a short focused interruption or blocking decision.

Use when

  • Use for short, self-contained work that benefits from preserving page context, or for interruptions that truly deserve focused attention. Do not use for long forms, multi-step tasks, or broad comparison work that needs more room and less interruption.

Avoid when

  • Avoid using consent-manager as a default simply because it is available in the library. Choose it only when its interaction cost, visibility, and behavior match the job to be done.
Task length
short
Interaction cost
high
Interruptiveness
high
Input precision
none
Mobile / touch risk
high
Accessibility risk
high
Needs background context
Yes
Comparison needed
No

Preferred alternatives

  • Inline content
  • Drawer or dedicated page for longer tasks

Anti-patterns

  • Long forms in dialogs
  • Multi-step or comparison-heavy modal workflows

API

manifest knowledge + registry-derived coverage

Props

Prop Type / values Default Description
storageKey string cookie-consent Declared by @props in the registry Blade source.
inline bool false Declared by @props in the registry Blade source.

Slots

Components use the default Blade slot unless a documented subcomponent is installed by the registry item.

Data slots

consent-manager

Capabilities

wcag-2.2-aa-target interactive responsive rtl darkMode localized

Behavior

  • Uses server-rendered Blade and semantic HTML.
  • Installs a JavaScript behavior module when the registry item includes resources/js/ui files.
  • Declares registry capability flags: a11y, interactive, responsive, rtl, darkMode, localized.

Usage

previews.components.consent-manager.default.blade.php Blade
<div class="w-full rounded-lg border border-border bg-card p-4">
    <x-ui.consent-manager :inline="true" />
</div>

Accessibility & localization

WCAG 2.2 AA RTL-ready data-slot Keyboard focus-visible Localized labels
  • Accessibility target: wcag-2.2-aa-target.
  • Uses semantic HTML and a stable data-slot attribute for styling/scripting hooks.
  • Focus-visible rings use the ring token so keyboard focus is always visible.
  • Disabled and invalid states are conveyed to assistive tech, not by color alone.
  • Targets WCAG 2.2 AA; verify contrast in light, dark, admin and customer surfaces above.
  • Labels go through __() and the component uses logical properties (ms-*, text-start, start-*) so it mirrors correctly — flip the preview to RTL to confirm.

Source

The exact, editable file ui:add writes into your app — copy it or own the whole thing. Previews render this same code; there are no preview-only components.

Changelog

Current version: v1.0.0. See the site changelog for the full release history.