useProductFilterActions

This hook provides actions to programmatically manage product filters from outside the filter modal. It allows setting, removing, and clearing filters on the product list page.

Import

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

Basic Usage

const {
  setFilter,
  setFilters,
  removeFilter,
  removeFilters,
  clearAllFilters,
  openFilterModal,
  currentFilters,
} = useProductFilterActions();

// Apply a single filter
setFilter({
  filterKey: 'product_type',
  filterValueID: 'shoes',
  filterValue: { label: 'Shoes', id: 'shoes', input: '...' },
});

// Remove all filters
clearAllFilters();

Return Value

Property	Type	Description
setFilter	Function	Applies a single filter. Signature: setFilter({ filterKey, filterValueID, filterValue }).
setFilters	Function	Applies multiple filters at once. Signature: setFilters([{ filterKey, filterValueID, filterValue }, ...]).
removeFilter	Function	Removes a single filter. Signature: removeFilter({ filterKey, filterValueID }).
removeFilters	Function	Removes multiple filters at once. Signature: removeFilters([{ filterKey, filterValueID }, ...]).
clearAllFilters	Function	Clears all applied filters.
openFilterModal	Function	Opens the filter modal. Signature: openFilterModal({ initialTabName }).
currentFilters	Object	The currently applied filters object.