Home > @yext/search-ui-react > FacetsProps
Props for the Facets() component.
Signature:
interface FacetsProps | Property | Modifiers | Type | Description |
|---|---|---|---|
| children? | ReactElement[] | ReactElement | undefined | null | (Optional) The custom facet components that will override the default rendering. | |
| customCssClasses? | FacetsCssClasses | (Optional) CSS classes for customizing the component styling. | |
| excludedFieldIds? | string[] | (Optional) List of field ids that should not be displayed. | |
| hierarchicalFieldIds? | string[] | (Optional) List of field ids that should be rendered as hierarchical facets. | |
| onlyRenderChildren? | boolean | (Optional) If set to true, only the facets specified in the children are rendered. If set to false, all facets are rendered with the ones specified in the children overridden. Default to false. | |
| searchOnChange? | boolean | (Optional) Whether or not a search is automatically run when a filter is selected. Defaults to true. |