Skip to content
UI Brok

Loading…

No results

Browse catalog

Editor Toolbar

A fixed formatting toolbar for the editor — turn-into block menu, mark toggles, lists, link and a more menu, wired to the editor by scoped events.

Preview

Formatting toolbar

Select text and use the toolbar to apply marks, change the block type, or insert a link.

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-toolbar

Behavior layer (Alpine)

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

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

Registry contract

Install confidence

php artisan ui:add editor-toolbar 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-toolbar.blade.php

Registry dependencies

button separator dropdown

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

  • Avoid using editor-toolbar 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
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

No documented props. Pass normal Blade attributes through the component root.

Slots

Components use the default Blade slot unless a documented subcomponent is installed by the registry item.

Data slots

editor-toolbar

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-toolbar.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>

    <h2>Formatting toolbar</h2>
    <p>Select text and use the toolbar to apply <strong>marks</strong>, change the block type, or insert a link.</p>
</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.