Interface CategoryFacet

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

Example:

interface CategoryFacet {
    facetSearch: CategoryFacetSearch;
    state: CategoryFacetState;
    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)

CoreCategoryFacet
- CategoryFacet

Index

Methods

deselectAll disable enable isSortedBy showLessValues showMoreValues sortBy subscribe toggleSelect

Properties

facetSearch state

Methods

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.
Inherited from CoreCategoryFacet.isSortedBy
- 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
Inherited from CoreCategoryFacet.showLessValues
- 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
Inherited from CoreCategoryFacet.showMoreValues
- 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
Inherited from CoreCategoryFacet.sortBy
- Defined in packages/headless/src/controllers/core/facets/category-facet/headless-core-category-facet.ts:112

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 CoreCategoryFacet.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
Inherited from CoreCategoryFacet.toggleSelect
- Defined in packages/headless/src/controllers/core/facets/category-facet/headless-core-category-facet.ts:100

Properties

facetSearch

facetSearch: CategoryFacetSearch

Provides methods to search the facet's values.

state

state: CategoryFacetState

The state of the Facet controller.

Interface CategoryFacet

Hierarchy (View Summary)

Index

Methods

Properties

Methods

deselectAll

Returns void

disable

Returns void

enable

Returns void

isSortedBy

Parameters

Returns boolean

showLessValues

Returns void

showMoreValues

Returns void

sortBy

Parameters

Returns void

subscribe

Parameters

Returns Unsubscribe

toggleSelect

Parameters

Returns void

Properties

facetSearch

state

Settings

On This Page