Interface DateFilter

The DateFilter controller makes it possible to create a date filter.

Example: date-filter.fn.tsx

interface DateFilter {
    state: DateFilterState;
    clear(): void;
    disable(): void;
    enable(): void;
    setRange(range: DateFilterRange): boolean;
    subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Controller
- DateFilter

Index

Methods

clear disable enable setRange subscribe

Properties

Methods

clear

clear(): void
Clears the current filter.

Returns void
- Defined in packages/headless/src/controllers/core/facets/range-facet/date-facet/headless-core-date-filter.ts:146

disable

disable(): void
Disables the filter. I.e., prevents it from filtering results.

Returns void
- Defined in packages/headless/src/controllers/core/facets/range-facet/date-facet/headless-core-date-filter.ts:166

enable

enable(): void
Enables the filter. I.e., undoes the effects of disable.

Returns void
- Defined in packages/headless/src/controllers/core/facets/range-facet/date-facet/headless-core-date-filter.ts:161

setRange

setRange(range: DateFilterRange): boolean
Updates the selected range.

You can use the buildDateRange utility method in order to format the range values correctly.
Parameters
- range: DateFilterRange
  The date range.
Returns boolean
Whether the range is valid.
- Defined in packages/headless/src/controllers/core/facets/range-facet/date-facet/headless-core-date-filter.ts:156

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/src/controllers/controller/headless-controller.ts:11

Properties

state

state: DateFilterState

The state of the DateFilter controller.