Interface CoreFacet

The Facet headless controller offers a high-level interface for designing a common facet UI controller.

interface CoreFacet {
    state: CoreFacetState;
    deselectAll(): void;
    disable(): void;
    enable(): void;
    isSortedBy(criterion: FacetSortCriterion): boolean;
    isValueExcluded(value: FacetValue): boolean;
    isValueSelected(value: FacetValue): boolean;
    showLessValues(): void;
    showMoreValues(): void;
    sortBy(criterion: FacetSortCriterion): void;
    subscribe(listener: () => void): Unsubscribe;
    toggleExclude(selection: FacetValue): void;
    toggleSelect(selection: FacetValue): void;
    toggleSingleExclude(selection: FacetValue): void;
    toggleSingleSelect(selection: FacetValue): void;
}

Hierarchy (View Summary)

Controller
- CoreFacet
  - Facet

Index

Methods

deselectAll disable enable isSortedBy isValueExcluded isValueSelected showLessValues showMoreValues sortBy subscribe toggleExclude toggleSelect toggleSingleExclude toggleSingleSelect

Properties

state

Methods

deselectAll

deselectAll(): void
Deselects all facet values.

Returns void
- Defined in packages/headless/src/controllers/core/facets/facet/headless-core-facet.ts:148

disable

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

Returns void
- Defined in packages/headless/src/controllers/core/facets/facet/headless-core-facet.ts:183

enable

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

Returns void
- Defined in packages/headless/src/controllers/core/facets/facet/headless-core-facet.ts:178

isSortedBy

isSortedBy(criterion: FacetSortCriterion): boolean
Checks whether the facet values are sorted according to the specified criterion.
Parameters
- criterion: FacetSortCriterion
  The criterion to compare.
Returns boolean
Whether the facet values are sorted according to the specified criterion.
- Defined in packages/headless/src/controllers/core/facets/facet/headless-core-facet.ts:163

isValueExcluded

isValueExcluded(value: FacetValue): boolean
Checks whether the specified facet value is excluded.
Parameters
- value: FacetValue
  The facet value to check.
Returns boolean
Whether the specified facet value is excluded.
- Defined in packages/headless/src/controllers/core/facets/facet/headless-core-facet.ts:143

isValueSelected

isValueSelected(value: FacetValue): boolean
Checks whether the specified facet value is selected.
Parameters
- value: FacetValue
  The facet value to check.
Returns boolean
Whether the specified facet value is selected.
- Defined in packages/headless/src/controllers/core/facets/facet/headless-core-facet.ts:135

showLessValues

showLessValues(): void
Sets the number of values displayed in the facet to the originally configured value.

Returns void
- Defined in packages/headless/src/controllers/core/facets/facet/headless-core-facet.ts:173

showMoreValues

showMoreValues(): void
Increases the number of values displayed in the facet to the next multiple of the originally configured value.

Returns void
- Defined in packages/headless/src/controllers/core/facets/facet/headless-core-facet.ts:168

sortBy

sortBy(criterion: FacetSortCriterion): void
Sorts the facet values according to the specified criterion.
Parameters
- criterion: FacetSortCriterion
  The criterion to use for sorting values.
Returns void
- Defined in packages/headless/src/controllers/core/facets/facet/headless-core-facet.ts:155

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

toggleExclude

toggleExclude(selection: FacetValue): void
Toggles exclusion of the specified facet value.
Parameters
- selection: FacetValue
  The facet value to toggle exclusion.
Returns void
- Defined in packages/headless/src/controllers/core/facets/facet/headless-core-facet.ts:113

toggleSelect

toggleSelect(selection: FacetValue): void
Toggles the specified facet value.
Parameters
- selection: FacetValue
  The facet value to toggle.
Returns void
- Defined in packages/headless/src/controllers/core/facets/facet/headless-core-facet.ts:106

toggleSingleExclude

toggleSingleExclude(selection: FacetValue): void
Excludes the specified facet value, deselecting others.
Parameters
- selection: FacetValue
  The facet value to toggle exclusion.
Returns void
- Defined in packages/headless/src/controllers/core/facets/facet/headless-core-facet.ts:127

toggleSingleSelect

toggleSingleSelect(selection: FacetValue): void
Toggles the specified facet value, deselecting others.
Parameters
- selection: FacetValue
  The facet value to toggle.
Returns void
- Defined in packages/headless/src/controllers/core/facets/facet/headless-core-facet.ts:120

Properties

state

state: CoreFacetState

The state of the Facet controller.

Interface CoreFacet

Hierarchy (View Summary)

Index

Methods

Properties

Methods

deselectAll

Returns void

disable

Returns void

enable

Returns void

isSortedBy

Parameters

Returns boolean

isValueExcluded

Parameters

Returns boolean

isValueSelected

Parameters

Returns boolean

showLessValues

Returns void

showMoreValues

Returns void

sortBy

Parameters

Returns void

subscribe

Parameters

Returns Unsubscribe

toggleExclude

Parameters

Returns void

toggleSelect

Parameters

Returns void

toggleSingleExclude

Parameters

Returns void

toggleSingleSelect

Parameters

Returns void

Properties

state

Settings

On This Page