Interface FacetSetActionCreators

The facet set action creators.

See Dispatch actions.

interface FacetSetActionCreators {
    deselectAllFacetValues(
        facetId: string,
    ): { payload: string; type: string };
    registerFacet(
        payload: RegisterFacetActionCreatorPayload,
    ): { payload: RegisterFacetActionCreatorPayload; type: string };
    toggleExcludeFacetValue(
        payload: ToggleSelectFacetValueActionCreatorPayload,
    ): { payload: ToggleSelectFacetValueActionCreatorPayload; type: string };
    toggleSelectFacetValue(
        payload: ToggleSelectFacetValueActionCreatorPayload,
    ): { payload: ToggleSelectFacetValueActionCreatorPayload; type: string };
    updateFacetAutoSelection(
        payload: UpdateFacetAutoSelectionActionCreatorPayload,
    ): { payload: UpdateFacetAutoSelectionActionCreatorPayload; type: string };
    updateFacetIsFieldExpanded(
        payload: UpdateFacetIsFieldExpandedActionCreatorPayload,
    ): {
        payload: UpdateFacetIsFieldExpandedActionCreatorPayload;
        type: string;
    };
    updateFacetNumberOfValues(
        payload: UpdateFacetNumberOfValuesActionCreatorPayload,
    ): { payload: UpdateFacetNumberOfValuesActionCreatorPayload; type: string };
    updateFacetSortCriterion(
        payload: UpdateFacetSortCriterionActionCreatorPayload,
    ): { payload: UpdateFacetSortCriterionActionCreatorPayload; type: string };
    updateFreezeCurrentValues(
        payload: UpdateFreezeCurrentValuesActionCreatorPayload,
    ): { payload: UpdateFreezeCurrentValuesActionCreatorPayload; type: string };
}

Index

Methods

deselectAllFacetValues registerFacet toggleExcludeFacetValue toggleSelectFacetValue updateFacetAutoSelection updateFacetIsFieldExpanded updateFacetNumberOfValues updateFacetSortCriterion updateFreezeCurrentValues

Methods

deselectAllFacetValues

deselectAllFacetValues(facetId: string): { payload: string; type: string }
Deselects all values of a facet.
Parameters
- facetId: string
  The unique identifier of the facet (e.g., "1").
Returns { payload: string; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/facets/facet-set/facet-set-actions-loader.ts:48

registerFacet

registerFacet(
payload: RegisterFacetActionCreatorPayload,
): { payload: RegisterFacetActionCreatorPayload; type: string }
Registers a facet in the facet set.
Parameters
- payload: RegisterFacetActionCreatorPayload
  The action creator payload.
Returns { payload: RegisterFacetActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/facets/facet-set/facet-set-actions-loader.ts:56

toggleExcludeFacetValue

toggleExcludeFacetValue(
payload: ToggleSelectFacetValueActionCreatorPayload,
): { payload: ToggleSelectFacetValueActionCreatorPayload; type: string }
Excludes a facet value. If the value does not exist, it is added.
Parameters
- payload: ToggleSelectFacetValueActionCreatorPayload
  The action creator payload.
Returns { payload: ToggleSelectFacetValueActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/facets/facet-set/facet-set-actions-loader.ts:76

toggleSelectFacetValue

toggleSelectFacetValue(
payload: ToggleSelectFacetValueActionCreatorPayload,
): { payload: ToggleSelectFacetValueActionCreatorPayload; type: string }
Toggles a facet value. If the value does not exist, it is added.
Parameters
- payload: ToggleSelectFacetValueActionCreatorPayload
  The action creator payload.
Returns { payload: ToggleSelectFacetValueActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/facets/facet-set/facet-set-actions-loader.ts:66

updateFacetAutoSelection

updateFacetAutoSelection(
payload: UpdateFacetAutoSelectionActionCreatorPayload,
): { payload: UpdateFacetAutoSelectionActionCreatorPayload; type: string }
Updates the preventAutoSelect flag of all facets
Parameters
- payload: UpdateFacetAutoSelectionActionCreatorPayload
  The action creator payload.
Returns { payload: UpdateFacetAutoSelectionActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/facets/facet-set/facet-set-actions-loader.ts:125

updateFacetIsFieldExpanded

updateFacetIsFieldExpanded(
payload: UpdateFacetIsFieldExpandedActionCreatorPayload,
): { payload: UpdateFacetIsFieldExpandedActionCreatorPayload; type: string }
Whether to expand (show more values than initially configured) or shrink down the facet.
Parameters
- payload: UpdateFacetIsFieldExpandedActionCreatorPayload
  The action creator payload.
Returns { payload: UpdateFacetIsFieldExpandedActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/facets/facet-set/facet-set-actions-loader.ts:86

updateFacetNumberOfValues

updateFacetNumberOfValues(
payload: UpdateFacetNumberOfValuesActionCreatorPayload,
): { payload: UpdateFacetNumberOfValuesActionCreatorPayload; type: string }
Updates the number of values of a facet.
Parameters
- payload: UpdateFacetNumberOfValuesActionCreatorPayload
  The action creator payload.
Returns { payload: UpdateFacetNumberOfValuesActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/facets/facet-set/facet-set-actions-loader.ts:96

updateFacetSortCriterion

updateFacetSortCriterion(
payload: UpdateFacetSortCriterionActionCreatorPayload,
): { payload: UpdateFacetSortCriterionActionCreatorPayload; type: string }
Updates the sort criterion of a facet.
Parameters
- payload: UpdateFacetSortCriterionActionCreatorPayload
  The action creator payload.
Returns { payload: UpdateFacetSortCriterionActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/facets/facet-set/facet-set-actions-loader.ts:106

updateFreezeCurrentValues

updateFreezeCurrentValues(
payload: UpdateFreezeCurrentValuesActionCreatorPayload,
): { payload: UpdateFreezeCurrentValuesActionCreatorPayload; type: string }
Updates the updateFreezeCurrentValues flag of a facet.
Parameters
- payload: UpdateFreezeCurrentValuesActionCreatorPayload
  The action creator payload.
Returns { payload: UpdateFreezeCurrentValuesActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/facets/facet-set/facet-set-actions-loader.ts:116