Interface StaticFilter

The StaticFilter controller manages a collection of filter values.

Example: static-filter.fn.tsx

interface StaticFilter {
    state: StaticFilterState;
    deselectAll(): void;
    isValueExcluded(value: StaticFilterValue): boolean;
    isValueSelected(value: StaticFilterValue): boolean;
    subscribe(listener: () => void): Unsubscribe;
    toggleExclude(value: StaticFilterValue): void;
    toggleSelect(value: StaticFilterValue): void;
    toggleSingleExclude(value: StaticFilterValue): void;
    toggleSingleSelect(value: StaticFilterValue): void;
}

Hierarchy (View Summary)

Controller
- StaticFilter

Index

Methods

deselectAll isValueExcluded isValueSelected subscribe toggleExclude toggleSelect toggleSingleExclude toggleSingleSelect

Properties

Methods

deselectAll

deselectAll(): void
Deselects all static filter values.

Returns void
- Defined in packages/headless/dist/definitions/controllers/static-filter/headless-static-filter.d.ts:59

isValueExcluded

isValueExcluded(value: StaticFilterValue): boolean
Checks whether the specified static filter value is excluded.
Parameters
- value: StaticFilterValue
  The static filter value to check.
Returns boolean
Whether the specified static filter value is excluded.
- Defined in packages/headless/dist/definitions/controllers/static-filter/headless-static-filter.d.ts:73

isValueSelected

isValueSelected(value: StaticFilterValue): boolean
Checks whether the specified static filter value is selected.
Parameters
- value: StaticFilterValue
  The static filter value to check.
Returns boolean
Whether the specified static filter value is selected.
- Defined in packages/headless/dist/definitions/controllers/static-filter/headless-static-filter.d.ts:66

subscribe

subscribe(listener: () => void): Unsubscribe
Adds a callback that's invoked on state change.
Parameters
- listener: () => void
  A callback that's invoked on state change.
Returns Unsubscribe
A function to remove the listener.
Inherited from Controller.subscribe
- Defined in packages/headless/dist/definitions/controllers/controller/headless-controller.d.ts:10

toggleExclude

toggleExclude(value: StaticFilterValue): void
Excludes the specified static filter value.
Parameters
- value: StaticFilterValue
  The static filter value to toggle.
Returns void
- Defined in packages/headless/dist/definitions/controllers/static-filter/headless-static-filter.d.ts:43

toggleSelect

toggleSelect(value: StaticFilterValue): void
Toggles the specified static filter value.
Parameters
- value: StaticFilterValue
  The static filter value to toggle.
Returns void
- Defined in packages/headless/dist/definitions/controllers/static-filter/headless-static-filter.d.ts:37

toggleSingleExclude

toggleSingleExclude(value: StaticFilterValue): void
Excludes the specified static filter value, deselecting others.
Parameters
- value: StaticFilterValue
  The static filter value to toggle exclusion.
Returns void
- Defined in packages/headless/dist/definitions/controllers/static-filter/headless-static-filter.d.ts:55

toggleSingleSelect

toggleSingleSelect(value: StaticFilterValue): void
Toggles the specified static filter value, deselecting others.
Parameters
- value: StaticFilterValue
  The static filter value to toggle.
Returns void
- Defined in packages/headless/dist/definitions/controllers/static-filter/headless-static-filter.d.ts:49

Properties

state

state: StaticFilterState

A state of the StaticFilter controller.