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)

Methods

deselectAll disable enable isSortedBy showLessValues showMoreValues sortBy subscribe toggleSelect

Properties

facetSearch state

Methods

deselectAll

  • deselectAll(): void

    Deselects all facet values.

    Returns void

disable

  • disable(): void

    Disables the facet. I.e., prevents it from filtering results.

    Returns void

enable

  • enable(): void

    Enables the facet. I.e., undoes the effects of disable.

    Returns void

isSortedBy

  • isSortedBy(criterion: CategoryFacetSortCriterion): boolean

    Checks whether the facet values are sorted according to the specified criterion.

    Parameters

    Returns boolean

    Whether the facet values are sorted according to the specified criterion.

showLessValues

  • showLessValues(): void

    Sets the number of values displayed in the facet to the originally configured value.

    Returns void

showMoreValues

  • showMoreValues(): void

    Increases the number of values displayed in the facet to the next multiple of the originally configured value.

    Returns void

sortBy

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.

toggleSelect

  • toggleSelect(selection: CategoryFacetValue): void

    Toggles the specified facet value.

    Parameters

    Returns void

Properties

facetSearch

facetSearch: CategoryFacetSearch

Provides methods to search the facet's values.

state

state: CategoryFacetState

The state of the Facet controller.

Settings

Member Visibility

On This Page

Methods
Properties