Skip to content
UI Brok

Loading…

No results

Browse catalog

Editor

A lightweight contenteditable rich-text surface with a toolbar slot, marks, block types and a reactive selection state other editor parts bind to.

Preview

The quick brown fox

A lightweight rich-text surface with bold, italic, an inline link and inline code.

Compose the toolbar, menus and inline controls around it.
  • Bulleted item
  • Another item
  1. Numbered step
  2. Second step
const editor = useEditor();
Draft Last edited just now

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

Behavior layer (Alpine)

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

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

Registry contract

Install confidence

php artisan ui:add 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
open
Stability
stable
Contract
v2
Foundation
≥ 1.0.0
Type Generated target
blade resources/views/components/ui/editor.blade.php
js resources/js/ui/editor.js

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

npm: alpinejs

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

  • Use rich editing only when structure, formatting, or collaboration justifies the complexity.
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

API

manifest knowledge + registry-derived coverage

Props

Prop Type / values Default Description
placeholder string Write something… Declared by @props in the registry Blade source.
ariaLabel string Rich text editor Declared by @props in the registry Blade source.

Slots

  • default — Primary Blade slot rendered by the component.

Data slots

editor editor-content editor-footer editor-toolbar-region

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.editor.default.blade.php Blade 
<x-ui.editor class="mx-auto max-w-2xl" placeholder="Write something…">
    <x-slot:toolbar>
        <x-ui.editor-toolbar />
    </x-slot:toolbar>

    <x-ui.editor-floating-toolbar />

    <h1>The quick brown fox</h1>
    <p>A lightweight rich-text surface with <strong>bold</strong>, <em>italic</em>, an
        <a href="#">inline link</a> and <code>inline code</code>.</p>
    <blockquote>Compose the toolbar, menus and inline controls around it.</blockquote>
    <ul><li>Bulleted item</li><li>Another item</li></ul>
    <ol><li>Numbered step</li><li>Second step</li></ol>
    <pre>const editor = useEditor();</pre>

    <x-slot:footer>
        <span>{{ __('Draft') }}</span>
        <span>{{ __('Last edited just now') }}</span>
    </x-slot:footer>
</x-ui.editor>

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.