@empathyco/x-components
Version:
Empathy X Components
35 lines (23 loc) • 1.07 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [useFacets](./x-components.usefacets.md)
## useFacets() function
Composable to share Facets logic.
**Signature:**
```typescript
export declare function useFacets(props: {
facetsIds?: Array<Facet['id']>;
alwaysVisible?: boolean;
}): {
selectedFiltersByFacet: ComputedRef<FiltersByFacet>;
selectedFilters: ComputedRef<Filter[]>;
hasSelectedFilters: ComputedRef<boolean>;
isVisible: ComputedRef<boolean>;
};
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| props | { facetsIds?: Array<Facet\['id'\]>; alwaysVisible?: boolean; } | Composable props. |
**Returns:**
{ selectedFiltersByFacet: ComputedRef<[FiltersByFacet](./x-components.filtersbyfacet.md)<!-- -->>; selectedFilters: ComputedRef<Filter\[\]>; hasSelectedFilters: ComputedRef<boolean>; isVisible: ComputedRef<boolean>; }
Composable.