Interface CategoryFacetSearch

interface CategoryFacetSearch {
    clear(): void;
    search(): void;
    select(value: CategoryFacetSearchResult): void;
    showMoreResults(): void;
    updateCaptions(captions: Record<string, string>): void;
    updateText(text: string): void;
}

Index

Methods

clear search select showMoreResults updateCaptions updateText

Methods

clear

clear(): void
Resets the query and empties the values.

Returns void
- Defined in packages/headless/dist/definitions/controllers/core/facets/category-facet/headless-core-category-facet.d.ts:159

search

search(): void
Performs a facet search.

Returns void
- Defined in packages/headless/dist/definitions/controllers/core/facets/category-facet/headless-core-category-facet.d.ts:149

select

select(value: CategoryFacetSearchResult): void
Selects a facet search result.
Parameters
- value: CategoryFacetSearchResult
  The search result to select.
Returns void
- Defined in packages/headless/dist/definitions/controllers/core/facets/category-facet/headless-core-category-facet.d.ts:155

showMoreResults

showMoreResults(): void
Shows more facet search results.

Returns void
- Defined in packages/headless/dist/definitions/controllers/core/facets/category-facet/headless-core-category-facet.d.ts:145

updateCaptions

updateCaptions(captions: Record<string, string>): void
Updates the facet value captions.
Parameters
- captions: Record<string, string>
  A dictionary that maps index field values to facet value display names.
Returns void
- Defined in packages/headless/dist/definitions/controllers/core/facets/category-facet/headless-core-category-facet.d.ts:164

updateText

updateText(text: string): void
Updates the facet search query.
Parameters
- text: string
  The facet search query.
Returns void
- Defined in packages/headless/dist/definitions/controllers/core/facets/category-facet/headless-core-category-facet.d.ts:141