Skip to content
UI Brok

Loading…

No results

Browse catalog

Label

Accessible label for form controls, with a required marker.

Preview

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 label

Registry contract

Install confidence

php artisan ui:add label 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/label.blade.php

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

Guidance

Form structure and labeling

Collect and organize related user input.

Use when

  • Use to collect, group, and clearly label related input so users understand what is being asked and can recover from errors. Do not create dense unlabeled forms; start from one thing per page or one conceptual question per step when the task is unfamiliar or high stakes.

Avoid when

  • Every input needs an explicit accessible label; placeholder text is not a reliable replacement.
Task length
medium
Interaction cost
medium
Interruptiveness
none
Input precision
constrained
Mobile / touch risk
medium
Accessibility risk
high
Needs background context
No
Comparison needed
No

Preferred alternatives

  • Focused question pages
  • A smaller set of directly labeled fields

Anti-patterns

  • Dense unlabeled forms
  • Collecting information without a task need

API

manifest knowledge + registry-derived coverage

Props

Prop Type / values Default Description
for mixed|null null Declared by @props in the registry Blade source.
required bool false Declared by @props in the registry Blade source.

Slots

  • default — Primary Blade slot rendered by the component.

Data slots

label

Capabilities

wcag-2.2-aa-target responsive rtl darkMode localized

Behavior

  • Uses server-rendered Blade and semantic HTML.
  • Declares registry capability flags: a11y, responsive, rtl, darkMode, localized.

Usage

previews.components.label.default.blade.php Blade 
<x-ui.label for="preview-name" :required="true">{{ __('Full name') }}</x-ui.label>

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.