---
title: "FacetOptions"
slug: "cloud-sdk-search-facetoptions"
abstract: "The FacetOptions interface represents facet settings for the search request."
---
# FacetOptions

|     |     |
| --- | --- |
| Type | Interface |
| Import path | `@sitecore-cloudsdk/search/browser` |

The facet object of the search widget item. Contains facet settings for the search request. For example, how many individual facets to retrieve and in what order.

## Signature

```typescript
export interface FacetOptions {
  all?: boolean;
  max?: number;
  coverage?: boolean;
  sort?: FacetSort;
  types?: ArrayOfAtLeastOne<FacetTypeOptions>;
}
```

## Properties

| Name | Type | Description | Value |
| --- | --- | --- | --- |
| `all` | `boolean` | Optional.<br><br>Whether to retrieve *all* facet types that were configured in Sitecore Search for this widget.<br><br>To configure the individual facets, use [`FacetTypeOptions`](https://doc.sitecore.com/sdk/en/developers/005/cloud-sdk/cloud-sdk-reference/cloud-sdk-search/cloud-sdk-search-browser/interfaces/cloud-sdk-search-facettypeoptions.html "FacetTypeOptions").<br><br>If `true`, the response will include all facet types defined in Sitecore Search, with their default configuration.<br><br>If `false`, the response will include only the facet types specified in `facet.types`.<br><br>Default: `false` | `true` |
| `max` | `integer` | Optional.<br><br>The maximum number of facet values to return per facet type.<br><br>We recommend that you request fewer than 50 facet values. If you request too many, you will see a lag in response times.<br><br>If unset, Sitecore Search returns maximum `10` facet values.<br><br>Minimum: `1`.<br><br>Maximum: `100`.<br><br>Default: `10`. | `10` |
| `coverage` | `boolean` | Optional.<br><br>Whether to include coverage computation for each facet type in the response.<br><br>Coverage is a number from `0` to `1`, representing the approximate percentage of the total matching index items which fall into at least one facet value.<br><br>Use coverage to filter out facets that may not be relevant to the search query. Enabling this setting may negatively affect performance.<br><br>Default: `false` | `true` |
| `sort` | [`FacetSort`](https://doc.sitecore.com/sdk/en/developers/005/cloud-sdk/cloud-sdk-reference/cloud-sdk-search/cloud-sdk-search-browser/interfaces/cloud-sdk-search-facetsort.html "FacetSort") | Optional.<br><br>Sorting configuration for the facet values in the individual facets. For example, the ability to sort in descending alphabetical order. | N/A |
| `types` | [`FacetTypeOptions[]`](https://doc.sitecore.com/sdk/en/developers/005/cloud-sdk/cloud-sdk-reference/cloud-sdk-search/cloud-sdk-search-browser/interfaces/cloud-sdk-search-facettypeoptions.html "FacetTypeOptions") | Optional.<br><br>The type object of a facet object. Settings for an individual facet.<br><br>Minimum length: 1. | N/A |