Home > @yext/search-ui-react > FilterSearchProps
The props for the FilterSearch() component.
Signature:
export interface FilterSearchProps
Property | Type | Description |
---|---|---|
customCssClasses? | FilterSearchCssClasses | (Optional) CSS classes for customizing the component styling. |
label? | string | (Optional) The display label for the component. |
placeholder? | string | (Optional) The search input's placeholder text when no text has been entered by the user. Defaults to "Search here...". |
searchFields | Omit<SearchParameterField, 'fetchEntities'>[] | An array of fieldApiName and entityType which indicates what to perform the filter search against. |
searchOnSelect? | boolean | (Optional) Whether to trigger a search when an option is selected. Defaults to false. |
sectioned? | boolean | (Optional) Determines whether or not the results of the filter search are separated by field. Defaults to false. |