Combobox
Autocomplete input with a filterable listbox and a hidden form value.
Preview
Single
Multiple
Controls
Device view renders in an isolated frame so real responsive breakpoints apply. Switch to Full for overflowing popovers.
Installation
php artisan ui:add combobox
Behavior layer (Alpine)
This component installs a self-registering Alpine module to
resources/js/ui/combobox.js. Import the behavior layer once
from your bundle so it loads (it hooks alpine:init):
import './combobox.js';
Registry contract
Install confidence
php artisan ui:add combobox
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/combobox.blade.php |
| blade | resources/views/components/ui/combobox/option.blade.php |
| js | resources/js/ui/combobox.js |
Registry dependencies
None.
Package dependencies
composer: jml/brok:^1.0
npm: alpinejs
Guidance
Searchable selection and filteringFind and select within a long or uncertain option set.
Use when
- Use when the option set is long enough that search, suggestion, or filtering speeds selection. Do not use advanced selection UI when a simpler visible control would be clearer.
Avoid when
- Choose this when long lists or uncertain labels make search and autocomplete valuable.
- Task length
- short
- Interaction cost
- medium
- Interruptiveness
- none
- Input precision
- constrained
- Mobile / touch risk
- medium
- Accessibility risk
- high
- Needs background context
- No
- Comparison needed
- No
Preferred alternatives
- Visible choices for small sets
- Dedicated filter panel for complex refinement
Anti-patterns
- Using advanced search for a tiny list
API
manifest knowledge + registry-derived coverageProps
| Prop | Type / values | Default | Description |
|---|---|---|---|
| name | string|null | null | Hidden input name for selected value. |
| placeholder | string | Search... | Input placeholder. |
| multiple | bool | false | Enable chip-style multi-select. |
| value | string | Declared by @props in the registry Blade source. | |
| label | string | Declared by @props in the registry Blade source. | |
| freeText | bool | false | Declared by @props in the registry Blade source. |
| clearable | bool | false | Declared by @props in the registry Blade source. |
Slots
default— Combobox option items.x-ui.combobox.option— Installed subcomponent from the registry item.
Data slots
combobox
combobox-clear
combobox-create
combobox-input
combobox-list
combobox-option
combobox-trigger
Capabilities
Behavior
- Uses server-rendered Blade and semantic HTML.
- Filters options as the user types and mirrors selection into hidden inputs for form submission.
- 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
<div class="w-full max-w-xs space-y-6">
<div>
<p class="mb-1.5 text-sm font-medium text-foreground">{{ __('Single') }}</p>
<x-ui.combobox name="framework" :placeholder="__('Select framework…')">
<x-ui.combobox.option value="laravel">Laravel</x-ui.combobox.option>
<x-ui.combobox.option value="rails">Ruby on Rails</x-ui.combobox.option>
<x-ui.combobox.option value="django">Django</x-ui.combobox.option>
<x-ui.combobox.option value="next">Next.js</x-ui.combobox.option>
<x-ui.combobox.option value="phoenix">Phoenix</x-ui.combobox.option>
</x-ui.combobox>
</div>
<div>
<p class="mb-1.5 text-sm font-medium text-foreground">{{ __('Multiple') }}</p>
<x-ui.combobox name="stacks" multiple :placeholder="__('Add frameworks…')">
<x-ui.combobox.option value="laravel">Laravel</x-ui.combobox.option>
<x-ui.combobox.option value="rails">Ruby on Rails</x-ui.combobox.option>
<x-ui.combobox.option value="django">Django</x-ui.combobox.option>
<x-ui.combobox.option value="next">Next.js</x-ui.combobox.option>
<x-ui.combobox.option value="phoenix">Phoenix</x-ui.combobox.option>
</x-ui.combobox>
</div>
</div>
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.2.0. See the site changelog for the full release history.