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

> **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 `QuanticFacet` displays a facet of the results for the current query.
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-facet engine-id={engineId} facet-id="myFacet" field="filetype" label="File Type" number-of-values="5" sort-criteria="occurrences" no-search display-values-as="link" is-collapsed></c-quantic-facet>
```

```html
<c-quantic-facet engine-id={engineId} field="filetype">
  <c-quantic-facet-caption slot="captions" value="text" caption="Plain text"></c-quantic-facet-caption>
  <c-quantic-facet-caption slot="captions" value="html" caption="Web page"></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 facet field.
| `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`
|

| `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 this facet is expanded, and the number of values to display when this facet is collapsed.
| `number`
| `8`

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

* `score`
* `alphanumeric`
* `occurrences`

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

| `noSearch`
| `no-search`
a| Whether this facet should not contain a search box.
| `boolean`
| `false`

| `displayValuesAs`
| `display-values-as`
a| Whether to display the facet values as checkboxes (multiple selection) or links (single selection). Possible values are 'checkbox', 'link'.
| `'checkbox', 'link'`
| `'checkbox'`

| `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`

| `injectionDepth`
| `injection-depth`
a| The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
Note: A high injectionDepth may negatively impact the facet request performance.
Minimum: `0`
| `number`
| `1000`

| `customSort` _(required)_
| `custom-sort`
a| Identifies the facet values that must appear at the top, in order.
This parameter can be used in conjunction with the `sortCriteria` parameter.
Facet values not part of the `customSort` list will be sorted according to the `sortCriteria`.
The maximum amount of custom sort values is 25.
The default value is `undefined`, and the facet values will be sorted using only the `sortCriteria`.
| `Array.<String>`
|

| `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-facet)