@empathyco/x-components
Version:
Empathy X Components
79 lines (36 loc) • 1.11 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-types](./x-types.md) > [Facet](./x-types.facet.md)
## Facet interface
Facet is a trait for filtering results. It uses [Filter](./x-types.filter.md) as filters.
**Signature:**
```typescript
export interface Facet extends NamedModel<FacetModelName>, Identifiable
```
**Extends:** [NamedModel](./x-types.namedmodel.md)<!-- --><[FacetModelName](./x-types.facetmodelname.md)<!-- -->>, [Identifiable](./x-types.identifiable.md)
## Properties
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[filters](./x-types.facet.filters.md)
</td><td>
</td><td>
[Filter](./x-types.filter.md)<!-- -->\[\]
</td><td>
Filters available for the facet.
</td></tr>
<tr><td>
[label](./x-types.facet.label.md)
</td><td>
</td><td>
string
</td><td>
Label that represents the facet text.
</td></tr>
</tbody></table>