Interface: GridFiltersPanelProps
Defined in: components/GridFiltersPanel.tsx:16
Extends
Properties
activeAvailability?
optionalactiveAvailability?:Availability
Defined in: components/GridFilters.tsx:101
Currently active availability selection (URL-driven). Seeds the toggle on the first render so a restored filtered URL renders it correctly.
Inherited from
GridFiltersProps.activeAvailability
activeFilterCount?
optionalactiveFilterCount?:number
Defined in: components/GridFiltersPanel.tsx:22
Number of active filters, shown as a badge on the mobile trigger button. The host computes this from its active filter state. Omit or 0 to hide the badge.
activeMinStock?
optionalactiveMinStock?:number
Defined in: components/GridFilters.tsx:104
Currently active minimum stock quantity (URL-driven). Undefined means the minimum.
Inherited from
GridFiltersProps.activeMinStock
activePriceMax?
optionalactivePriceMax?:number
Defined in: components/GridFilters.tsx:84
Currently active price filter max from URL state.
Inherited from
GridFiltersProps.activePriceMax
activePriceMin?
optionalactivePriceMin?:number
Defined in: components/GridFilters.tsx:81
Currently active price filter min from URL state. When both activePriceMin and activePriceMax become undefined the price inputs reset to the priceMin/priceMax bounds.
Inherited from
GridFiltersProps.activePriceMin
activeTextFilters?
optionalactiveTextFilters?:Record<string,string[]>
Defined in: components/GridFilters.tsx:75
Currently active text filters (URL-driven). Syncs internal checkbox state when filters are removed externally.
Inherited from
GridFiltersProps.activeTextFilters
className?
optionalclassName?:string
Defined in: components/GridFilters.tsx:116
Extra CSS class on the root element.
Inherited from
clearSignal?
optionalclearSignal?:number
Defined in: components/GridFilters.tsx:72
Increment this counter to reset all selected filters and price inputs externally.
Inherited from
collapsed?
optionalcollapsed?:boolean
Defined in: components/GridFilters.tsx:69
Whether filter accordions start collapsed. Defaults to true.
Inherited from
currency?
optionalcurrency?:string
Defined in: components/GridFilters.tsx:123
Currency symbol shown in the price-range inputs. Falls back to PropellerInfra.currency, then '€'.
Inherited from
filters
filters:
AttributeFilter[]
Defined in: components/GridFilters.tsx:22
Attribute filter definitions from the ProductGrid API response. Each entry describes one filterable attribute (e.g. colour, brand, size).
Inherited from
getSelectedFilters?
optionalgetSelectedFilters?: () =>void
Defined in: components/GridFilters.tsx:37
Notification called after every filter change.
Returns
void
Inherited from
GridFiltersProps.getSelectedFilters
isLoading?
optionalisLoading?:boolean
Defined in: components/GridFilters.tsx:113
When true, all checkboxes and price inputs are disabled.
Wire to ProductGrid's onLoadingChange to block rapid re-clicks while a fetch is in flight.
Inherited from
isMobile?
optionalisMobile?:boolean
Defined in: components/GridFilters.tsx:54
Enable mobile-specific behaviour (drops sticky positioning).
Inherited from
labels?
optionallabels?:Record<string,string>
Defined in: components/GridFilters.tsx:120
Translated labels keyed by the slugs used inside the component (see
getLabel calls). Missing keys fall back to the English defaults.
Inherited from
language?
optionallanguage?:string
Defined in: components/GridFilters.tsx:34
Language code. Defaults to 'NL'.
Inherited from
onAvailabilityChange?
optionalonAvailabilityChange?: (sel,minStock) =>void
Defined in: components/GridFilters.tsx:107
Called on every toggle or stepper change with both values.
Parameters
sel
Availability
minStock
number
Returns
void
Inherited from
GridFiltersProps.onAvailabilityChange
onClearFilters?
optionalonClearFilters?: () =>void
Defined in: components/GridFilters.tsx:51
Called when "Clear all" is clicked.
Returns
void
Inherited from
GridFiltersProps.onClearFilters
onFilterChange
onFilterChange: (
filter,value) =>void
Defined in: components/GridFilters.tsx:43
Called on every checkbox toggle.
filter is the AttributeFilter; value is the toggled option string.
Parameters
filter
AttributeFilter
value
string | number
Returns
void
Inherited from
GridFiltersProps.onFilterChange
onPriceChange?
optionalonPriceChange?: (minPrice,maxPrice) =>void
Defined in: components/GridFilters.tsx:48
Called when the price range changes (on blur / slider release).
Parameters
minPrice
number
maxPrice
number
Returns
void
Inherited from
GridFiltersProps.onPriceChange
portalMode?
optionalportalMode?:string
Defined in: components/GridFilters.tsx:60
'open' — show price filter for all users. 'semi-closed' — hide price filter for unauthenticated users.
Inherited from
priceMax?
optionalpriceMax?:number
Defined in: components/GridFilters.tsx:31
Upper price bound from the current product set.
Inherited from
priceMin?
optionalpriceMin?:number
Defined in: components/GridFilters.tsx:28
Lower price bound from the current product set.
When both priceMin and priceMax are absent the price section is hidden.
Inherited from
showAvailabilityFilter?
optionalshowAvailabilityFilter?:boolean
Defined in: components/GridFilters.tsx:95
Show the availability (stock) section. Defaults to false so hosts opt in rather than gaining a new filter section on upgrade.
The host should pass its own "show stock" setting here — a stock filter is meaningless when no stock is displayed anywhere in the grid. When truthy the section is still subject to the same semi-closed-portal visibility rule as the price filter (hidden for anonymous users).
Inherited from
GridFiltersProps.showAvailabilityFilter
user?
optionaluser?:Contact|Customer|null
Defined in: components/GridFilters.tsx:63
Authenticated user — price filter visibility depends on this in semi-closed mode.
Inherited from
wrapperClassName?
optionalwrapperClassName?:string
Defined in: components/GridFiltersPanel.tsx:25
Extra CSS class on the outer panel root.