Interface CoreCategoryFacet

The CategoryFacet headless controller offers a high-level interface for designing a facet UI controller that renders values hierarchically.

interface CoreCategoryFacet {
    state: CoreCategoryFacetState;
    deselectAll(): void;
    disable(): void;
    enable(): void;
    isSortedBy(criterion: CategoryFacetSortCriterion): boolean;
    showLessValues(): void;
    showMoreValues(): void;
    sortBy(criterion: CategoryFacetSortCriterion): void;
    subscribe(listener: () => void): Unsubscribe;
    toggleSelect(selection: CategoryFacetValue): void;
}

Hierarchy (View Summary)

Controller
- CoreCategoryFacet
  - CategoryFacet

Index

Methods

deselectAll disable enable isSortedBy showLessValues showMoreValues sortBy subscribe toggleSelect

Properties

Methods

deselectAll

deselectAll(): void
Deselects all facet values.

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

disable

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

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

enable

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

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

isSortedBy

isSortedBy(criterion: CategoryFacetSortCriterion): boolean
Checks whether the facet values are sorted according to the specified criterion.
Parameters
- criterion: CategoryFacetSortCriterion
  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/category-facet/headless-core-category-facet.ts:120

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/category-facet/headless-core-category-facet.ts:130

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/category-facet/headless-core-category-facet.ts:125

sortBy

sortBy(criterion: CategoryFacetSortCriterion): void
Sorts the facet values according to the specified criterion.
Parameters
- criterion: CategoryFacetSortCriterion
  The criterion by which to sort values.
Returns void
- Defined in packages/headless/src/controllers/core/facets/category-facet/headless-core-category-facet.ts:112

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

toggleSelect

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

Properties

state

state: CoreCategoryFacetState

The state of the Facet controller.