StaticFilterSetActions

This is for:

Developer

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 (e.g., "abc").

Returns PayloadAction<string>: A dispatchable action.

registerStaticFilter

Registers a static filter.

Parameters

Returns PayloadAction<RegisterStaticFilterActionCreatorPayload>: A dispatchable action.

toggleExcludeStaticFilterValue

Excludes a static filter value.

Parameters

Returns PayloadAction<ToggleSelectStaticFilterValueActionCreatorPayload>: 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 (e.g., Youtube).

  • expression: string

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

  • state: FacetValueState

    The state of the static filter value. The possible values are idle, selected, excluded.

ToggleSelectStaticFilterValueActionCreatorPayload

Properties

  • id: string

    The unique identifier for the static filter.

  • value: StaticFilterValue

    The target static filter value.