Document Editors
Pro editing surfaces for documents and spreadsheets.
Preview
Couldn't load this workbook
Check that the file exists and is a valid .xlsx file.
Controls
Device view renders in an isolated frame so real responsive breakpoints apply. Switch to Full for overflowing popovers.
Installation
php artisan ui:add pro/excel-editor
Behavior layer (Alpine)
This component installs a self-registering Alpine module to
resources/js/ui/excel-editor.js. Import the behavior layer once
from your bundle so it loads (it hooks alpine:init):
import './excel-editor.js';
Registry contract
Install confidence
php artisan ui:add pro/excel-editor
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
- pro
- Stability
- stable
- Contract
- v2
- Foundation
- ≥ 1.0.0
| Type | Generated target |
|---|---|
| blade | resources/views/components/ui/excel-editor.blade.php |
| js | resources/js/ui/excel-editor.js |
Registry dependencies
Package dependencies
composer: jml/brok:^1.0
npm: alpinejs
npm: @e965/xlsx
Guidance
Document workflowUpload, inspect, edit, annotate, or sign a real document.
Use when
- Use when users need to upload, inspect, edit, annotate, or sign real documents as part of the workflow. Do not use a heavy document interface when the same task can be completed more simply in structured product UI.
Avoid when
- Avoid using excel-editor 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
- precise
- Mobile / touch risk
- high
- Accessibility risk
- high
- Needs background context
- Yes
- Comparison needed
- Yes
Preferred alternatives
- Structured product form
- Direct data entry
Anti-patterns
- Heavy document UI when structured fields are simpler
API
manifest knowledge + registry-derived coverageProps
| Prop | Type / values | Default | Description |
|---|---|---|---|
| src | mixed|null | null | Declared by @props in the registry Blade source. |
| data | 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
excel-editor
excel-editor-error
excel-editor-grid
excel-editor-grid-area
excel-editor-loading
excel-editor-toolbar
Capabilities
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
<div class="mx-auto h-[32rem] w-full max-w-4xl">
<x-ui.excel-editor src="/samples/sample.xlsx" />
</div>
Accessibility & localization
data-slot
Keyboard focus-visible
Localized labels
- Accessibility target: wcag-2.2-aa-target.
- Uses semantic HTML and a stable
data-slotattribute for styling/scripting hooks. - Focus-visible rings use the
ringtoken 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.