Interface StaticFilterSetActionCreators

The static filter set action creators.

interface StaticFilterSetActionCreators {
    deselectAllStaticFilterValues(
        id: string,
    ): { payload: string; type: string };
    registerStaticFilter(
        payload: RegisterStaticFilterActionCreatorPayload,
    ): { payload: RegisterStaticFilterActionCreatorPayload; type: string };
    toggleExcludeStaticFilterValue(
        payload: ToggleSelectStaticFilterValueActionCreatorPayload,
    ): {
        payload: ToggleSelectStaticFilterValueActionCreatorPayload;
        type: string;
    };
    toggleSelectStaticFilterValue(
        payload: ToggleSelectStaticFilterValueActionCreatorPayload,
    ): {
        payload: ToggleSelectStaticFilterValueActionCreatorPayload;
        type: string;
    };
}

Index

Methods

deselectAllStaticFilterValues registerStaticFilter toggleExcludeStaticFilterValue toggleSelectStaticFilterValue

Methods

deselectAllStaticFilterValues

deselectAllStaticFilterValues(id: string): { payload: string; type: string }
Deselects all values of a filter.
Parameters
- id: string
  The unique identifier of the static filter (e.g., "abc").
Returns { payload: string; type: string }
A dispatchable action.
- Defined in packages/headless/dist/definitions/features/static-filter-set/static-filter-set-actions-loader.d.ts:39

registerStaticFilter

registerStaticFilter(
payload: RegisterStaticFilterActionCreatorPayload,
): { payload: RegisterStaticFilterActionCreatorPayload; type: string }
Registers a static filter.
Parameters
- payload: RegisterStaticFilterActionCreatorPayload
  The action creator payload.
Returns { payload: RegisterStaticFilterActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/dist/definitions/features/static-filter-set/static-filter-set-actions-loader.d.ts:18

toggleExcludeStaticFilterValue

toggleExcludeStaticFilterValue(
    payload: ToggleSelectStaticFilterValueActionCreatorPayload,
): {
    payload: ToggleSelectStaticFilterValueActionCreatorPayload;
    type: string;
}
Excludes a static filter value.
Parameters
- payload: ToggleSelectStaticFilterValueActionCreatorPayload
  The action creator payload.
Returns { payload: ToggleSelectStaticFilterValueActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/dist/definitions/features/static-filter-set/static-filter-set-actions-loader.d.ts:32

toggleSelectStaticFilterValue

toggleSelectStaticFilterValue(
    payload: ToggleSelectStaticFilterValueActionCreatorPayload,
): {
    payload: ToggleSelectStaticFilterValueActionCreatorPayload;
    type: string;
}
Toggles a static filter value.
Parameters
- payload: ToggleSelectStaticFilterValueActionCreatorPayload
  The action creator payload.
Returns { payload: ToggleSelectStaticFilterValueActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/dist/definitions/features/static-filter-set/static-filter-set-actions-loader.d.ts:25