Interface AutomaticFacetsActionCreators

The action creators to manage automatic facets.

interface AutomaticFacetsActionCreators {
    deselectAllAutomaticFacetValues(
        field: string,
    ): { payload: string; type: string };
    setOptions(
        options: Partial<AutomaticFacetGeneratorOptions>,
    ): { payload: P; type: string };
    toggleSelectAutomaticFacetValue(
        payload: ToggleSelectAutomaticFacetValueActionCreatorPayload,
    ): {
        payload: ToggleSelectAutomaticFacetValueActionCreatorPayload;
        type: string;
    };
}

Index

Methods

deselectAllAutomaticFacetValues setOptions toggleSelectAutomaticFacetValue

Methods

deselectAllAutomaticFacetValues

deselectAllAutomaticFacetValues(
field: string,
): { payload: string; type: string }
Deselects all values of an automatic facet.
Parameters
- field: string
  The field of the automatic facet.
Returns { payload: string; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/facets/automatic-facet-set/automatic-facet-set-actions-loader.ts:35

setOptions

setOptions(
options: Partial<AutomaticFacetGeneratorOptions>,
): { payload: P; type: string }
Sets the options of the automatic facet generator.
Parameters
- options: Partial<AutomaticFacetGeneratorOptions>
  Options of the automatic facet generator containing both the desiredCount and the numberOfValues.
Returns { payload: P; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/facets/automatic-facet-set/automatic-facet-set-actions-loader.ts:25

toggleSelectAutomaticFacetValue

toggleSelectAutomaticFacetValue(
    payload: ToggleSelectAutomaticFacetValueActionCreatorPayload,
): {
    payload: ToggleSelectAutomaticFacetValueActionCreatorPayload;
    type: string;
}
Toggles an automatic facet value.
Parameters
- payload: ToggleSelectAutomaticFacetValueActionCreatorPayload
  The action creator payload.
Returns { payload: ToggleSelectAutomaticFacetValueActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/facets/automatic-facet-set/automatic-facet-set-actions-loader.ts:43

Interface AutomaticFacetsActionCreators

Index

Methods

Methods

deselectAllAutomaticFacetValues

Parameters

Returns { payload: string; type: string }

setOptions

Parameters

Returns { payload: P; type: string }

toggleSelectAutomaticFacetValue

Parameters

Returns { payload: ToggleSelectAutomaticFacetValueActionCreatorPayload; type: string }

Settings

On This Page