Skip to content

Commit

Permalink
update imports, add excludedFieldIds
Browse files Browse the repository at this point in the history
  • Loading branch information
EmilyZhang777 committed May 12, 2023
1 parent 806c474 commit d445536
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 6 deletions.
13 changes: 13 additions & 0 deletions docs/search-ui-react.facetsprops.excludedfieldids.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-ui-react](./search-ui-react.md) &gt; [FacetsProps](./search-ui-react.facetsprops.md) &gt; [excludedFieldIds](./search-ui-react.facetsprops.excludedfieldids.md)

## FacetsProps.excludedFieldIds property

List of filter ids that should not be displayed.

<b>Signature:</b>

```typescript
excludedFieldIds?: string[];
```
1 change: 1 addition & 0 deletions docs/search-ui-react.facetsprops.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,6 @@ export interface FacetsProps
| --- | --- | --- |
| [children?](./search-ui-react.facetsprops.children.md) | ReactElement\[\] \| ReactElement \| undefined \| null | <i>(Optional)</i> The custom facet components that will override the default rendering. |
| [customCssClasses?](./search-ui-react.facetsprops.customcssclasses.md) | [FacetsCssClasses](./search-ui-react.facetscssclasses.md) | <i>(Optional)</i> CSS classes for customizing the component styling. |
| [excludedFieldIds?](./search-ui-react.facetsprops.excludedfieldids.md) | string\[\] | <i>(Optional)</i> List of filter ids that should not be displayed. |
| [searchOnChange?](./search-ui-react.facetsprops.searchonchange.md) | boolean | <i>(Optional)</i> Whether or not a search is automatically run when a filter is selected. Defaults to true. |

3 changes: 2 additions & 1 deletion etc/search-ui-react.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { AnalyticsConfig } from '@yext/analytics';
import { AnalyticsService } from '@yext/analytics';
import { AutocompleteResponse } from '@yext/search-headless-react';
import { DirectAnswer as DirectAnswer_2 } from '@yext/search-headless-react';
import { DisplayableFacetOption } from '@yext/search-core';
import { DisplayableFacetOption } from '@yext/search-headless-react';
import { FieldValueStaticFilter } from '@yext/search-headless-react';
import { FilterSearchResponse } from '@yext/search-headless-react';
import { HighlightedValue } from '@yext/search-headless-react';
Expand Down Expand Up @@ -220,6 +220,7 @@ export interface FacetsCssClasses {
export interface FacetsProps {
children?: ReactElement[] | ReactElement | undefined | null;
customCssClasses?: FacetsCssClasses;
excludedFieldIds?: string[];
searchOnChange?: boolean;
}

Expand Down
4 changes: 3 additions & 1 deletion src/components/FacetProps.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { DisplayableFacetOption } from '@yext/search-core';
import { DisplayableFacetOption } from '@yext/search-headless-react';
import { FilterGroupCssClasses } from './FilterGroup';
import { ReactElement } from 'react';

Expand All @@ -22,6 +22,8 @@ export interface FacetsProps {
searchOnChange?: boolean,
/** CSS classes for customizing the component styling. */
customCssClasses?: FacetsCssClasses,
/** List of filter ids that should not be displayed. */
excludedFieldIds?: string[],
/** The custom facet components that will override the default rendering.
*
* @remarks
Expand Down
8 changes: 4 additions & 4 deletions test-site/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit d445536

Please sign in to comment.