Preview

package.json

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 json-viewer

Behavior layer (Alpine)

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

resources/js/ui/index.js JS

import './json-viewer.js';

Registry contract

Install confidence

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

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

npm: alpinejs

Guidance

Scannable data display

Present data for rapid scanning.

Use when

Use to summarize, sequence, or present data so users can scan it quickly. Do not add display-only ornament when the user needs actionable structure or exact comparison instead.

Avoid when

Avoid using json-viewer 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: low
Interruptiveness: none
Input precision: none
Mobile / touch risk: low
Accessibility risk: medium
Needs background context: No
Comparison needed: Yes

Preferred alternatives

Table for exact comparison
Plain text for a single value

Anti-patterns

Adding display ornament without informational value

API

manifest knowledge + registry-derived coverage

Props

Prop	Type / values	Default	Description
data	array	[]	Declared by @props in the registry Blade source.
title	mixed\|null	null	Declared by @props in the registry Blade source.
showLineNumbers	bool	true	Declared by @props in the registry Blade source.
showColorIndent	bool	false	Declared by @props in the registry Blade source.
collapseOn	string	click	Declared by @props in the registry Blade source.
defaultExpanded	bool	false	Declared by @props in the registry Blade source.
truncation	mixed\|null	null	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

json-viewer

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.json-viewer.default.blade.php Blade

@php
    $data = [
        'name' => 'jml/brok',
        'version' => '1.1.0',
        'open' => true,
        'components' => ['button', 'timeline', 'heatmap', 'flip-clock'],
        'meta' => [
            'license' => 'MIT',
            'downloads' => 1280,
            'nested' => ['level' => 2, 'items' => [1, 2, 3]],
        ],
    ];
@endphp

<x-ui.json-viewer :data="$data" title="package.json" :default-expanded="2" class="w-full max-w-md" />

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.

JSON Viewer