Skip to content
UI Brok

Loading…

No results

Browse catalog

Diff Viewer

A code diff visualiser with unified or split layouts, a change summary and copy-to-clipboard.

Preview

counter.js
+3 −2
1 export function counter(start) {
1 + export function counter(start = 0) {
2 2 let count = start;
3 return () => count++;
3 + const next = () => ++count;
4 + return next;
4 5 }

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

Registry contract

Install confidence

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

Registry dependencies

copy-button

Package dependencies

composer: jml/brok:^1.0

Guidance

Developer and documentation tool

Expose exact technical or diagnostic information.

Use when

  • Use for exact technical detail, code readability, diagnostics, and copyable reference material. Do not surface developer-specific patterns in end-user flows unless the task genuinely requires them.

Avoid when

  • Avoid using diff-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
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

  • Plain-language product UI for nontechnical users

Anti-patterns

  • Exposing developer tooling in end-user flows without a task need
Related: copy-button

API

manifest knowledge + registry-derived coverage

Props

Prop Type / values Default Description
oldCode mixed|null null Declared by @props in the registry Blade source.
newCode mixed|null null Declared by @props in the registry Blade source.
lines mixed|null null Declared by @props in the registry Blade source.
layout string unified Declared by @props in the registry Blade source.
language mixed|null null Declared by @props in the registry Blade source.
oldTitle mixed|null null Declared by @props in the registry Blade source.
newTitle 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

diff-viewer

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.diff-viewer.default.blade.php Blade
@php
    $old = "export function counter(start) {\n  let count = start;\n  return () => count++;\n}";
    $new = "export function counter(start = 0) {\n  let count = start;\n  const next = () => ++count;\n  return next;\n}";
@endphp

<x-ui.diff-viewer
    :old-code="$old"
    :new-code="$new"
    old-title="counter.js"
    new-title="counter.js"
    layout="unified"
    class="w-full"
/>

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.