Preview

Text / Surface 17.85:1 AAA On primary 4.47:1 Fail Muted 2.45:1 Fail

17.85:1 2.28:1 1.20:1

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 color-contrast

Registry contract

Install confidence

php artisan ui:add color-contrast 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/color-contrast.blade.php

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

Guidance

Design-token documentation

Inspect and govern design-system decisions.

Use when

Use to document, inspect, and apply design-system decisions consistently across teams and AI tooling. Do not present token-level controls to end users who only need product functionality.

Avoid when

Avoid using color-contrast 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: medium
Interaction cost: medium
Interruptiveness: none
Input precision: precise
Mobile / touch risk: low
Accessibility risk: medium
Needs background context: No
Comparison needed: No

Preferred alternatives

Product-level controls for end users

Anti-patterns

Exposing implementation tokens as product settings

API

manifest knowledge + registry-derived coverage

Props

Prop	Type / values	Default	Description
base	mixed\|null	null	Declared by @props in the registry Blade source.
against	mixed\|null	null	Declared by @props in the registry Blade source.
ratio	mixed\|null	null	Declared by @props in the registry Blade source.
passes	mixed\|null	null	Declared by @props in the registry Blade source.
label	mixed\|null	null	Declared by @props in the registry Blade source.
variant	string	pill	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

color-contrast color-contrast-badge color-contrast-ratio color-contrast-swatch

Capabilities

wcag-2.2-aa-target responsive rtl darkMode localized

Behavior

Uses server-rendered Blade and semantic HTML.
Declares registry capability flags: a11y, responsive, rtl, darkMode, localized.

Usage

previews.components.color-contrast.default.blade.php Blade

<div class="flex flex-col items-start gap-4">
    <div class="flex flex-wrap items-center gap-3">
        <x-ui.color-contrast base="#0f172a" against="#ffffff" label="Text / Surface" />
        <x-ui.color-contrast base="#ffffff" against="#6366f1" label="On primary" />
        <x-ui.color-contrast base="#94a3b8" against="#f8fafc" label="Muted" />
    </div>

    <div class="flex flex-wrap items-center gap-3">
        <x-ui.color-contrast variant="icon" base="#0f172a" against="#ffffff" />
        <x-ui.color-contrast variant="icon" base="#ffffff" against="#22c55e" />
        <x-ui.color-contrast variant="icon" base="#cbd5e1" against="#e2e8f0" />
    </div>
</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.

Color Contrast