Livewire Search
A debounced search input that entangles a Livewire property at runtime, so each keystroke drives a server-side query and a server-set value updates the input. Requires Livewire 3.
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 livewire-search
Registry contract
Install confidence
php artisan ui:add livewire-search
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/livewire-search.blade.php |
Registry dependencies
None.
Package dependencies
composer: jml/brok:^1.0
Guidance
Livewire framework adapterAdd server-driven behavior to an existing interaction pattern.
Use when
- Use this Livewire variant when the same core pattern needs server-driven interactivity. Apply the underlying base component’s usability rules; the framework integration does not change when the pattern is appropriate.
Avoid when
- Apply the search guidance and retain visible navigation for users who do not know the target label.
- Task length
- short
- Interaction cost
- medium
- Interruptiveness
- none
- Input precision
- none
- Mobile / touch risk
- medium
- Accessibility risk
- high
- Needs background context
- Yes
- Comparison needed
- No
Preferred alternatives
- Base component without server round trips
Anti-patterns
- Treating framework integration as a UX rationale
API
manifest knowledge + registry-derived coverageProps
| Prop | Type / values | Default | Description |
|---|---|---|---|
| wireModel | mixed|null | null | Declared by @props in the registry Blade source. |
| debounce | int | 300 | Declared by @props in the registry Blade source. |
| placeholder | string | Search… | Declared by @props in the registry Blade source. |
| value | string | Declared by @props in the registry Blade source. |
Slots
Components use the default Blade slot unless a documented subcomponent is installed by the registry item.
Data slots
livewire-search
livewire-search-clear
livewire-search-input
Capabilities
Behavior
- Uses server-rendered Blade and semantic HTML.
- Declares registry capability flags: a11y, responsive, rtl, darkMode, localized, requires.
Usage
<div class="w-full max-w-sm">
<x-ui.livewire-search wire-model="query" :debounce="300" placeholder="Search invoices…" />
</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.0.0. See the site changelog for the full release history.