Preview

Add an image

A captioned image element.

annual-report.pdf PDF

annual-report.pdf

Embedded content

https://example.com/embed/123

An embedded resource.

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 editor-media

Registry contract

Install confidence

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

Registry dependencies

aspect-ratio badge

Package dependencies

composer: jml/brok:^1.0

Guidance

Rich authoring and editing

Create or revise structured rich content.

Use when

Use when users need rich structured authoring, annotation, or collaborative editing controls. Do not use rich editor affordances for simple one-line or plain-text tasks.

Avoid when

Avoid using editor-media 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: long
Interaction cost: high
Interruptiveness: none
Input precision: freeform
Mobile / touch risk: high
Accessibility risk: high
Needs background context: Yes
Comparison needed: No

Preferred alternatives

Textarea or plain field for simple content

Anti-patterns

Rich editors for one-line or easily validated input

Related: aspect-ratio badge

API

manifest knowledge + registry-derived coverage

Props

Prop	Type / values	Default	Description
type	string	image	Declared by @props in the registry Blade source.
src	mixed\|null	null	Declared by @props in the registry Blade source.
alt	string		Declared by @props in the registry Blade source.
caption	mixed\|null	null	Declared by @props in the registry Blade source.
align	string	center	Declared by @props in the registry Blade source.
ratio	mixed	16 / 9	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

editor-media

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.editor-media.default.blade.php Blade

<div class="mx-auto grid max-w-2xl gap-6 p-6">
    <x-ui.editor-media type="image" caption="A captioned image element." />
    <x-ui.editor-media type="file" caption="annual-report.pdf" />
    <x-ui.editor-media type="embed" src="https://example.com/embed/123" caption="An embedded resource." />
</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.

Editor Media