Preview

Loading document…

Couldn't load this document

Check that the file exists and is a valid .docx file.

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 pro/docx-editor

Behavior layer (Alpine)

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

resources/js/ui/index.js JS

import './docx-editor.js';

Registry contract

Install confidence

php artisan ui:add pro/docx-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: experimental
Contract: v2
Foundation: ≥ 1.0.0

Type	Generated target
blade	resources/views/components/ui/docx-editor.blade.php
js	resources/js/ui/docx-editor.js

Registry dependencies

button spinner

Package dependencies

composer: jml/brok:^1.0

npm: alpinejs

npm: mammoth

Guidance

Document workflow

Upload, 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 docx-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

Related: button spinner

API

manifest knowledge + registry-derived coverage

Props

Prop	Type / values	Default	Description
src	string		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

docx-editor docx-editor-content docx-editor-error docx-editor-loading docx-editor-surface docx-editor-toolbar

Capabilities

wcag-2.2-aa-target interactive responsive rtl darkMode localized experimental

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, experimental.

Usage

previews.components.docx-editor.default.blade.php Blade

<div class="mx-auto h-[36rem] w-full max-w-3xl">
    <x-ui.docx-editor src="/samples/sample.docx" />
</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.

Document Editors