Skip to content
UI Brok

Loading…

No results

Browse catalog

Filters

A faceted filter toolbar of popover facets with searchable multi-select option lists, count badges, and a clear-all action.

Preview

No results.

No results.

No results.

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 filters

Behavior layer (Alpine)

This component installs a self-registering Alpine module to resources/js/ui/filters.js. Import the behavior layer once from your bundle so it loads (it hooks alpine:init):

resources/js/ui/index.js JS
import './filters.js';

Registry contract

Install confidence

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

Registry dependencies

badge

Package dependencies

composer: jml/brok:^1.0

npm: alpinejs

Guidance

Searchable selection and filtering

Find 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

  • As filter complexity rises, use a dedicated panel, sheet, or page rather than only chips or inline toggles.
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
Related: badge

API

manifest knowledge + registry-derived coverage

Props

Prop Type / values Default Description
facets mixed|null null Declared by @props in the registry Blade source.
name mixed|null null 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

filters filters-clear filters-popover filters-trigger

Capabilities

wcag-2.2-aa-target interactive responsive rtl darkMode localized

Behavior

  • Uses server-rendered Blade and semantic HTML.
  • 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

previews.components.filters.default.blade.php Blade
<div class="w-full max-w-2xl">
    <x-ui.filters />
</div>

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.