Skip to content
UI Brok

Loading…

No results

Browse catalog

Dropzone

A drag-and-drop file upload with click-to-browse, accept + max-size validation, a removable file list, and a hidden native input that submits in an ordinary multipart form.

Preview

Drag & drop files here, or browse

.pdf,image/* · 10 MB max per file

PDF or images, up to 10 MB each.

Controls

Disabled
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 dropzone

Behavior layer (Alpine)

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

resources/js/ui/index.js JS
import './dropzone.js';

Registry contract

Install confidence

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

Registry dependencies

button

Package dependencies

composer: jml/brok:^1.0

npm: alpinejs

Guidance

File input and upload

Attach an existing external file.

Use when

  • Use when users must provide an existing file and drag-and-drop or file selection reduces effort. Show accepted types, size limits, progress, errors, and a keyboard-accessible file picker; do not require dragging as the only input method.

Avoid when

  • Always provide a conventional file-picker path, clear constraints, upload progress, and recoverable errors. Drag-and-drop must remain optional.
Task length
short
Interaction cost
high
Interruptiveness
none
Input precision
constrained
Mobile / touch risk
high
Accessibility risk
high
Needs background context
No
Comparison needed
No

Preferred alternatives

  • Direct structured form entry
  • Conventional file picker

Anti-patterns

  • Requiring drag-and-drop
  • Hiding file constraints until validation fails
Related: button

API

manifest knowledge + registry-derived coverage

Props

Prop Type / values Default Description
disabled false|true false Documented catalog control used by the preview workbench.
name mixed|null null Declared by @props in the registry Blade source.
multiple bool true Declared by @props in the registry Blade source.
accept mixed|null null Declared by @props in the registry Blade source.
maxSize int 10 Declared by @props in the registry Blade source.

Slots

  • x-ui.dropzone.dropzone — Installed subcomponent from the registry item.

Data slots

dropzone dropzone-files

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.dropzone.default.blade.php Blade
<div class="mx-auto w-full max-w-md">
    <x-ui.field name="attachments" label="Upload files" hint="PDF or images, up to 10 MB each.">
        <x-ui.dropzone name="attachments" accept=".pdf,image/*" :max-size="10" />
    </x-ui.field>
</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.