Input Group
Attaches icons, text, or buttons to an input within one bordered group.
Preview
Controls
Device view renders in an isolated frame so real responsive breakpoints apply. Switch to Full for overflowing popovers.
Installation
php artisan ui:add input-group
Registry contract
Install confidence
php artisan ui:add input-group
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/input-group.blade.php |
| blade | resources/views/components/ui/input-group/input.blade.php |
| blade | resources/views/components/ui/input-group/addon.blade.php |
| blade | resources/views/components/ui/input-group/text.blade.php |
| blade | resources/views/components/ui/input-group/button.blade.php |
Registry dependencies
None.
Package dependencies
composer: jml/brok:^1.0
Guidance
Freeform text inputCollect 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 input-group 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 coverageProps
| Prop | Type / values | Default | Description |
|---|---|---|---|
| align | string | inline-start | Declared by @props in the registry Blade source. |
Slots
default— Primary Blade slot rendered by the component.x-ui.input-group.input— Installed subcomponent from the registry item.x-ui.input-group.addon— Installed subcomponent from the registry item.x-ui.input-group.text— Installed subcomponent from the registry item.x-ui.input-group.button— Installed subcomponent from the registry item.
Data slots
input-group
input-group-addon
input-group-button
input-group-input
input-group-text
Capabilities
Behavior
- Uses server-rendered Blade and semantic HTML.
- Declares registry capability flags: a11y, responsive, rtl, darkMode, localized.
Usage
<x-ui.input-group>
<x-ui.input-group.addon>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true">
<circle cx="11" cy="11" r="8" />
<path d="m21 21-4.3-4.3" />
</svg>
</x-ui.input-group.addon>
<x-ui.input-group.input placeholder="{{ __('Search...') }}" />
<x-ui.input-group.addon align="inline-end">
<x-ui.input-group.button>{{ __('Go') }}</x-ui.input-group.button>
</x-ui.input-group.addon>
</x-ui.input-group>
Accessibility & localization
data-slot
Keyboard focus-visible
Localized labels
- Accessibility target: wcag-2.2-aa-target.
- Uses semantic HTML and a stable
data-slotattribute for styling/scripting hooks. - Focus-visible rings use the
ringtoken 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.