StaticFilterSetActions (Deprecated)

This is for:

Developer
Warning

Headless v1 has been deprecated. We recommend using the latest version of the Coveo Headless library.

The static filter set action creators.

See Dispatch Actions.

Loader Function

loadStaticFilterSetActions

Loads the staticFilterSet reducer and returns possible action creators.

Parameters

  • engine: SearchEngine

    The headless engine.

Returns StaticFilterSetActionCreators: The static filter set action creators.

StaticFilterSetActionCreators

deselectAllStaticFilterValues

Deselects all values of a filter.

Parameters

  • id: string

    The unique identifier of the static filter (for example, "abc").

Returns PayloadAction<string>: A dispatchable action.

registerStaticFilter

Registers a static filter.

Parameters

Returns PayloadAction<RegisterStaticFilterActionCreatorPayload>: A dispatchable action.

toggleSelectStaticFilterValue

Toggles a static filter value.

Parameters

Returns PayloadAction<ToggleSelectStaticFilterValueActionCreatorPayload>: A dispatchable action.

RegisterStaticFilterActionCreatorPayload

Properties

  • id: string

    A unique identifier for the static filter.

  • values: StaticFilterValue[]

    The values of the static filter.

StaticFilterValue

Properties

  • caption: string

    A human-readable caption for the expression (for example, Youtube).

  • expression: string

    The query filter expression to apply when the value is selected (for example, @filetype=="youtubevideo").

  • state: 'idle' | 'selected'

    The state of the static filter value.

ToggleSelectStaticFilterValueActionCreatorPayload

Properties

  • id: string

    The unique identifier for the static filter.

  • value: StaticFilterValue

    The target static filter value.