Interface FacetOptionsActionCreators

The facetOptions action creators.

interface FacetOptionsActionCreators {
    disableFacet(facetId: string): { payload: string; type: string };
    enableFacet(facetId: string): { payload: string; type: string };
    updateFacetOptions(
        payload: UpdateFacetOptionsActionCreatorPayload,
    ): { payload: UpdateFacetOptionsActionCreatorPayload; type: string };
}

Index

Methods

disableFacet enableFacet updateFacetOptions

Methods

disableFacet

disableFacet(facetId: string): { payload: string; type: string }
Disables a facet. I.e., prevents it from filtering results.
Parameters
- facetId: string
  The unique identifier of the facet (for example, "1").
Returns { payload: string; type: string }
A dispatchable action.
- Defined in packages/headless/dist/definitions/features/facet-options/facet-options-actions-loader.d.ts:32

enableFacet

enableFacet(facetId: string): { payload: string; type: string }
Enables a facet. I.e., undoes the effects of disable.
Parameters
- facetId: string
  The unique identifier of the facet (for example, "abcd").
Returns { payload: string; type: string }
A dispatchable action.
- Defined in packages/headless/dist/definitions/features/facet-options/facet-options-actions-loader.d.ts:25

updateFacetOptions

updateFacetOptions(
payload: UpdateFacetOptionsActionCreatorPayload,
): { payload: UpdateFacetOptionsActionCreatorPayload; type: string }
Updates options that affect facet reordering. For more information, refer to the documentation on query parameters.
Parameters
- payload: UpdateFacetOptionsActionCreatorPayload
  The action creator payload.
Returns { payload: UpdateFacetOptionsActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/dist/definitions/features/facet-options/facet-options-actions-loader.d.ts:18