<pagefind-filter-pane>
A full filter panel displaying all available filters. Filters automatically populate based on your indexed content.
<pagefind-filter-pane></pagefind-filter-pane>
Attributes
| Attribute | Type | Default | Description |
|---|---|---|---|
show-empty |
boolean | false |
Show filter options with zero results |
expanded |
boolean | false |
Always show groups expanded (non-collapsible) |
open |
string | "" |
Comma-separated filter names to start open |
sort |
string | "default" |
Sort filter values: default, alphabetical, count-desc, count-asc |
auto-open-threshold |
number | 6 |
Max values for auto-opening single groups (0 to disable) |
instance |
string | "default" |
Connect to a specific Pagefind instance |
Auto-open Behavior
By default, filter groups are collapsible. If there is only one group, and it has options at or below the auto-open-threshold, it will open automatically.
Groups can also be opened by listing their keys in the open attribute.
Filter Visibility
- Options with zero matching results are hidden by default (unless
show-emptyis set or the option is selected) - If all options in a group are hidden, the entire group is hidden
Faceted Search Mode
For catalog-style interfaces where users browse by filters without requiring a search term, enable faceted mode via <pagefind-config>:
<pagefind-config faceted preload></pagefind-config>
In faceted mode, all results are shown initially and update immediately when filters are changed. See the config component documentation for details.