Skip to content
UI Brok

Loading…

No results

Browse catalog

Charts

Token-themed data visualisations — the core multi-series chart plus dependency-free SVG variants for sankey, word-cloud, venn, liquid and violin plots.

Chart

Preview

This wrapper requires ApexCharts. Run `npm install apexcharts` and make it available on `window` to render charts; until then a loading state is shown.

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 chart

Behavior layer (Alpine)

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

resources/js/ui/index.js JS
import './chart.js';

Registry contract

Install confidence

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

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

npm: alpinejs

npm: apexcharts

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

  • Choose a chart only when the user’s question is inherently visual, such as trend, distribution, flow, or relationship.
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
type bar|line|area|pie|mixed bar ApexCharts chart type.
series array [] ApexCharts series payload.
options array [] ApexCharts options merged with token-themed defaults.
height int 320 Chart and fallback minimum height in pixels.
label string Chart Accessible role="img" label.

Slots

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

Data slots

chart

Capabilities

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

Behavior

  • Uses server-rendered Blade and semantic HTML.
  • Loads ApexCharts, applies token-aware defaults, renders into the referenced container, and shows a fallback while loading or on error.
  • 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.chart.default.blade.php Blade
<div class="space-y-4">
    <x-ui.chart
        type="bar"
        :height="300"
        :series="[['name' => __('Revenue'), 'data' => [30, 40, 35, 50, 49, 60, 70]]]"
        :options="['xaxis' => ['categories' => ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul']]]"
        label="{{ __('Monthly revenue') }}"
    />

    <p class="text-sm text-muted-foreground">
        {{ __('This wrapper requires ApexCharts. Run `npm install apexcharts` and make it available on `window` to render charts; until then a loading state is shown.') }}
    </p>
</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.4.0. See the site changelog for the full release history.