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.

Word Cloud

Preview

A dependency-free word cloud. Pass `:words` (each with a `text` and an integer `weight`) — heavier words render larger and cluster centrally; hover any word for its weight.

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-wordcloud

Behavior layer (Alpine)

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

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

Registry contract

Install confidence

php artisan ui:add chart-wordcloud 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/chart-wordcloud.blade.php
js resources/js/ui/chart-wordcloud.js

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

npm: alpinejs

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 chart-wordcloud 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
words mixed|null null Declared by @props in the registry Blade source.
height int 320 Declared by @props in the registry Blade source.
label string Word cloud 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

chart-wordcloud chart-wordcloud-tooltip chart-wordcloud-word

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.chart-wordcloud.default.blade.php Blade 
<div class="space-y-4">
    <x-ui.chart-wordcloud :height="320" label="{{ __('Top topics') }}" />

    <p class="text-sm text-muted-foreground">
        {{ __('A dependency-free word cloud. Pass `:words` (each with a `text` and an integer `weight`) — heavier words render larger and cluster centrally; hover any word for its weight.') }}
    </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.0.0. See the site changelog for the full release history.