useFilterOptions

This hook provides access to the filter selection state and actions for the product list filter UI. It allows selecting, removing, and clearing filters.

Import

import { useFilterOptions } from '@appmaker-xyz/shopify';

Basic Usage

const {
  selectedFilters,
  selectFilter,
  removeFilter,
  clearSelectedFilters,
  isFilterSelected,
  hasAnyFilterSelected,
  priceRange,
} = useFilterOptions();

Return Value

Property	Type	Description
selectedFilters	Object	Currently selected filters keyed by filter key and value ID.
priceRange	Object	Current price range filter state.
selectFilter	Function	Selects a filter option. Signature: selectFilter(filterKey, filterValueId, filterValue).
removeFilter	Function	Removes a filter option. Signature: removeFilter(filterKey, filterValueId).
getSelectedFilters	Function	Returns the current selected filters object.
isFilterSelected	Function	Checks if a specific filter is selected.
clearSelectedFilters	Function	Clears all selected filters.
hasAnyFilterSelected	Function	Returns whether any filter is currently selected.