Skip to content
UI Brok

Loading…

No results

Browse catalog

Activity Grid

Calendar contribution grids — a configurable heatmap and a GitHub-style activity graph with a less/more legend.

Heatmap

Preview

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 heatmap

Registry contract

Install confidence

php artisan ui:add heatmap 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.2
License
open
Stability
stable
Contract
v2
Foundation
≥ 1.0.0
Type Generated target
blade resources/views/components/ui/heatmap.blade.php

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

Guidance

Chart and visual analytics

Reveal a visual trend, distribution, flow, or relationship.

Use when

  • Use when trend, distribution, flow, intensity, or relationship questions are easier to answer visually than in raw numbers. Do not use a chart when users mainly need exact lookup or when a single metric would be clearer as text or a stat.

Avoid when

  • Avoid using heatmap 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
none
Mobile / touch risk
high
Accessibility risk
high
Needs background context
No
Comparison needed
Yes

Preferred alternatives

  • Table for exact lookup
  • Stat for a single value

Anti-patterns

  • Decorative charts without a meaningful question

API

manifest knowledge + registry-derived coverage

Props

Prop Type / values Default Description
data array [] Declared by @props in the registry Blade source.
startDate mixed|null null Declared by @props in the registry Blade source.
endDate mixed|null null Declared by @props in the registry Blade source.
cellSize int 16 Declared by @props in the registry Blade source.
gap int 4 Declared by @props in the registry Blade source.
daysOfTheWeek string MWF Declared by @props in the registry Blade source.
displayStyle string squares Declared by @props in the registry Blade source.
colorMode string discrete Declared by @props in the registry Blade source.
colorScale mixed|null null Declared by @props in the registry Blade source.
maxColor mixed|null null Declared by @props in the registry Blade source.
minColor mixed|null null Declared by @props in the registry Blade source.
interpolation string linear 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

heatmap

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.heatmap.default.blade.php Blade 
@php
    // Deterministic sample data so the preview/test render is stable.
    $start = \Illuminate\Support\Carbon::create(2026, 1, 1);
    $end = \Illuminate\Support\Carbon::create(2026, 4, 1);
    $data = [];
    $seed = 7;
    for ($d = $start->copy(); $d->lte($end); $d->addDay()) {
        $seed = ($seed * 1103515245 + 12345) % 2147483648;
        $v = $seed % 6;
        if ($v > 0) {
            $data[] = ['date' => $d->toDateString(), 'value' => $v];
        }
    }
@endphp

<x-ui.heatmap :data="$data" :start-date="$start->toDateString()" :end-date="$end->toDateString()" />

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.2. See the site changelog for the full release history.