Skip to content
UI Brok

Loading…

No results

Browse catalog

Textarea

Multi-line text input with invalid and disabled states.

Preview

Controls

Invalid
Disabled
Theme
Surface
Direction
Viewport

Device view renders in an isolated frame so real responsive breakpoints apply. Switch to Full for overflowing popovers.

Options

Visual options rendered from the current preview target.

Invalid

False
True

Installation

terminal
php artisan ui:add textarea

Registry contract

Install confidence

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

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

Guidance

Freeform text input

Collect unpredictable freeform information.

Use when

  • Use when users must enter freeform information that cannot be reliably selected from a list. Do not choose a freeform field when a constrained choice would reduce errors or cognitive load.

Avoid when

  • Avoid using textarea 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
short
Interaction cost
medium
Interruptiveness
none
Input precision
freeform
Mobile / touch risk
medium
Accessibility risk
medium
Needs background context
No
Comparison needed
No

Preferred alternatives

  • Radio or checkbox for bounded choices
  • Select or combobox for known options

Anti-patterns

  • Using freeform entry for a bounded answer set

API

manifest knowledge + registry-derived coverage

Props

Prop Type / values Default Description
invalid bool false Applies destructive border and focus ring.
disabled false|true false Documented catalog control used by the preview workbench.
rows int 4 Declared by @props in the registry Blade source.

Slots

  • default — Primary Blade slot rendered by the component.

Data slots

textarea

Capabilities

wcag-2.2-aa-target responsive rtl darkMode localized

Behavior

  • Uses server-rendered Blade and semantic HTML.
  • Forwards native textarea attributes and preserves placeholder, disabled, required, rows, and aria-* semantics.
  • Declares registry capability flags: a11y, responsive, rtl, darkMode, localized.

Usage

previews.components.textarea.default.blade.php Blade
<x-ui.textarea aria-label="{{ __('Message') }}" class="max-w-sm">{{ __('Type your message here.') }}</x-ui.textarea>

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.2.0. See the site changelog for the full release history.