Preview

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 video-mask

Registry contract

Install confidence

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

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

Guidance

Media selection and presentation

Select, preview, or compare visual media.

Use when

Use when image or video selection, preview, or media-based comparison is part of the task. Do not require media-heavy interaction when a simpler text or list solution would be faster.

Avoid when

Avoid using video-mask 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: high
Interruptiveness: none
Input precision: none
Mobile / touch risk: high
Accessibility risk: high
Needs background context: No
Comparison needed: Yes

Preferred alternatives

Text or list representation

Anti-patterns

Requiring media-heavy interaction when text is faster

API

manifest knowledge + registry-derived coverage

Props

Prop	Type / values	Default	Description
src	string		Declared by @props in the registry Blade source.
poster	string		Declared by @props in the registry Blade source.
shape	string	blob	Declared by @props in the registry Blade source.
aspect	string	16 / 9	Declared by @props in the registry Blade source.
autoplay	bool	true	Declared by @props in the registry Blade source.
loop	bool	true	Declared by @props in the registry Blade source.
muted	bool	true	Declared by @props in the registry Blade source.
controls	bool	false	Declared by @props in the registry Blade source.
label	string	Decorative video	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

video-mask

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.video-mask.default.blade.php Blade

<div class="flex justify-center">
    <x-ui.video-mask
        poster="https://picsum.photos/seed/video-mask/960/540"
        shape="blob"
        class="w-full max-w-md"
    />
</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.

Media Masking