---
title: QuanticCategoryFacet
slug: latest-search-category-facet
canonical_url: https://docs.coveo.com/en/quantic/latest/reference/search-components/search-category-facet/
collection: quantic
source_format: adoc
---
# QuanticCategoryFacet

> **Note**
>
> This component was introduced in version `1.6.1`.

A facet is a list of values for a certain field occurring in the results, ordered using a configurable criterion (for example, number of occurrences).
A `QuanticCategoryFacet` displays field values in a browsable, hierarchical fashion.
Custom captions can be provided by adding caption provider components to the `captions` named slot.
See [Create a custom caption provider component for Quantic facets](https://docs.coveo.com/en/quantic/latest/usage/create-custom-caption-provider-component/).

## Examples

```html
<c-quantic-category-facet engine-id={engineId} facet-id="myfacet" field="geographicalhierarchy" label="Country" base-path="Africa,Togo,Lome" no-filter-by-base-path delimiting-character="/" number-of-values="5" is-collapsed></c-quantic-category-facet>
```

```html
<c-quantic-category-facet engine-id={engineId} field="geographicalhierarchy">
  <c-quantic-facet-caption slot="captions" value="United States" caption="United States of America"></c-quantic-facet-caption>
  <c-quantic-facet-caption slot="captions" value="usa" caption="USA"></c-quantic-facet-caption>
</c-quantic-facet>
```

## Properties

--
|===
| Property | Attribute | Description | Type | Default

| `engineId` _(required)_
| `engine-id`
a| The ID of the engine instance the component registers to.
| `string`
|

| `facetId`
| `facet-id`
a| A unique identifier for the facet.
Defaults to the `field` value.
| `string`
| Defaults to the `field` value.

| `field` _(required)_
| `field`
a| The field whose values you want to display in the facet.
| `string`
|

| `label` _(required)_
| `label`
a| The non-localized label for the facet. This label is displayed in the facet header.
| `string`
|

| `basePath`
| `base-path`
a| The base path shared by all facet values, separated by commas.
| `string`
| `''`

| `noFilterByBasePath`
| `no-filter-by-base-path`
a| Whether not to use the `basePath` as a filter for the results.
| `boolean`
| `false`

| `noFilterFacetCount`
| `no-filter-facet-count`
a| Whether not to exclude the parents of folded results when estimating the result count for each facet value.
| `boolean`
| `false`

| `delimitingCharacter`
| `delimiting-character`
a| The character that separates the values of the target multi-value field.
If the field is defined as &quot;hierarchical&quot;, parts of a path are delimited by `;`. A value is indexed as `parent;child` and `delimitingCharacter` should be set to `;`.
| `string`
| `;`

| `numberOfValues`
| `number-of-values`
a| The number of values to request for this facet.
Also determines the number of additional values to request each time more values are shown.
| `number`
| `8`

| `sortCriteria`
| `sort-criteria`
a| The sort criterion to apply to the returned facet values.
Possible values are:

* `alphanumeric`: Filters are sorted in alphanumerical order.
* `occurrences`: Filters are sorted in descending order of number of occurrences.

| `'alphanumeric', 'occurrences'`
| `'occurrences'`

| `withSearch`
| `with-search`
a| Whether this facet should contain a search box.
| `boolean`
| `false`

| `dependsOn` _(required)_
| `depends-on`
a| This property defines the relationship between this facet and a parent facet, indicating
the specific parent facet that this facet relies on and the selected value required
from that parent facet for this facet to be displayed.
When this property is defined, the facet will only display if the specified `parentFacetId`
has the `expectedValue` selected. If `expectedValue` is omitted or set to `undefined`,
the facet will display as long as any value is selected in the parent facet.
<strong>Supported facets:</strong> Dependencies can only be created on a basic or category facet.
Dependencies on numeric, timeframe, or date facets are not supported.
For example usage and more details, see:
https://docs.coveo.com/en/quantic/latest/usage/display-facet-based-on-selection-of-another-facet/
| `DependsOn`
|

| `isCollapsed`
| `is-collapsed`
a| Whether the facet is collapsed.
| `boolean`
| `false`

|===
--

## XML configuration file elements

The following XML configuration file elements apply (see [XML Configuration File Elements](https://developer.salesforce.com/docs/component-library/documentation/en/lwc/lwc.reference_configuration_tags)).

--
|===
| Metadata | Value

| `apiVersion` | `53.0`
| `isExposed` | `false`
|===
--

## Associated use cases

This component is also relevant in the following use case:

* [Insight Panel](https://docs.coveo.com/en/quantic/latest/reference/insight-panel-components/insight-panel-category-facet)