-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
# Version 1.3.0 ### Features - Introduce new Facet components including the new Facets (#360), StandardFacet (#370), NumericalFacet (#375), and HierarchicalFacet (#373) components which support more customizability than the previous Facet components. - Support the new RichTextV2 (Lexical) and Markdown fields which have been converted to HTML as FeaturedSnippetDirectAnswers (#379) - Remove the Yext logo from the search bar (#376) - Deprecate LocationBias (#338) component in favor of the new Geolocation component (#336) ### Bug fixes - Improve the UX of the search bar when long autocomplete text is returned which includes the truncation of long text (#378)
- Loading branch information
Showing
106 changed files
with
3,056 additions
and
159 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-ui-react](./search-ui-react.md) > [FacetProps](./search-ui-react.facetprops.md) | ||
|
||
## FacetProps type | ||
|
||
Props for a single facet component. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare type FacetProps = StandardFacetProps | NumericalFacetProps | HierarchicalFacetProps; | ||
``` | ||
<b>References:</b> [StandardFacetProps](./search-ui-react.standardfacetprops.md)<!-- -->, [NumericalFacetProps](./search-ui-react.numericalfacetprops.md)<!-- -->, [HierarchicalFacetProps](./search-ui-react.hierarchicalfacetprops.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-ui-react](./search-ui-react.md) > [Facets](./search-ui-react.facets.md) | ||
|
||
## Facets() function | ||
|
||
A component that displays all facets applicable to the current vertical search. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare function Facets(props: FacetsProps): JSX.Element; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| props | [FacetsProps](./search-ui-react.facetsprops.md) | [FacetsProps](./search-ui-react.facetsprops.md) | | ||
|
||
<b>Returns:</b> | ||
|
||
JSX.Element | ||
|
||
A React component for facets | ||
|
||
## Remarks | ||
|
||
This component is a quick way of getting facets on the page, and it will render standard facets, numerical facets, and hierarchical facets. The [StandardFacet()](./search-ui-react.standardfacet.md)<!-- -->, [NumericalFacet()](./search-ui-react.numericalfacet.md)<!-- -->, and [HierarchicalFacet()](./search-ui-react.hierarchicalfacet.md) components can be used to override the default facet configuration. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-ui-react](./search-ui-react.md) > [FacetsCssClasses](./search-ui-react.facetscssclasses.md) > [divider](./search-ui-react.facetscssclasses.divider.md) | ||
|
||
## FacetsCssClasses.divider property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
divider?: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-ui-react](./search-ui-react.md) > [FacetsCssClasses](./search-ui-react.facetscssclasses.md) > [facetsContainer](./search-ui-react.facetscssclasses.facetscontainer.md) | ||
|
||
## FacetsCssClasses.facetsContainer property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
facetsContainer?: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-ui-react](./search-ui-react.md) > [FacetsCssClasses](./search-ui-react.facetscssclasses.md) | ||
|
||
## FacetsCssClasses interface | ||
|
||
The CSS class interface for [Facets()](./search-ui-react.facets.md)<!-- -->. Any [FilterGroupCssClasses](./search-ui-react.filtergroupcssclasses.md) props will be overridden by the same props from customCssClasses on [StandardFacetProps](./search-ui-react.standardfacetprops.md)<!-- -->, [NumericalFacetProps](./search-ui-react.numericalfacetprops.md)<!-- -->, or [HierarchicalFacetProps](./search-ui-react.hierarchicalfacetprops.md)<!-- -->. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface FacetsCssClasses extends FilterGroupCssClasses | ||
``` | ||
<b>Extends:</b> [FilterGroupCssClasses](./search-ui-react.filtergroupcssclasses.md) | ||
## Properties | ||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [divider?](./search-ui-react.facetscssclasses.divider.md) | string | <i>(Optional)</i> | | ||
| [facetsContainer?](./search-ui-react.facetscssclasses.facetscontainer.md) | string | <i>(Optional)</i> | | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-ui-react](./search-ui-react.md) > [FacetsProps](./search-ui-react.facetsprops.md) > [children](./search-ui-react.facetsprops.children.md) | ||
|
||
## FacetsProps.children property | ||
|
||
The custom facet components that will override the default rendering. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
children?: ReactElement[] | ReactElement | undefined | null; | ||
``` | ||
|
||
## Remarks | ||
|
||
Supported components include [StandardFacet()](./search-ui-react.standardfacet.md)<!-- -->, [NumericalFacet()](./search-ui-react.numericalfacet.md)<!-- -->. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) > [@yext/search-ui-react](./search-ui-react.md) > [FacetsProps](./search-ui-react.facetsprops.md) > [customCssClasses](./search-ui-react.facetsprops.customcssclasses.md) | ||
|
||
## FacetsProps.customCssClasses property | ||
|
||
CSS classes for customizing the component styling. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
customCssClasses?: FacetsCssClasses; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) > [@yext/search-ui-react](./search-ui-react.md) > [FacetsProps](./search-ui-react.facetsprops.md) > [excludedFieldIds](./search-ui-react.facetsprops.excludedfieldids.md) | ||
|
||
## FacetsProps.excludedFieldIds property | ||
|
||
List of field ids that should not be displayed. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
excludedFieldIds?: string[]; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) > [@yext/search-ui-react](./search-ui-react.md) > [FacetsProps](./search-ui-react.facetsprops.md) > [hierarchicalFieldIds](./search-ui-react.facetsprops.hierarchicalfieldids.md) | ||
|
||
## FacetsProps.hierarchicalFieldIds property | ||
|
||
List of field ids that should be rendered as hierarchical facets. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
hierarchicalFieldIds?: string[]; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-ui-react](./search-ui-react.md) > [FacetsProps](./search-ui-react.facetsprops.md) | ||
|
||
## FacetsProps interface | ||
|
||
Props for the [Facets()](./search-ui-react.facets.md) component. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface FacetsProps | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [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 field ids that should not be displayed. | | ||
| [hierarchicalFieldIds?](./search-ui-react.facetsprops.hierarchicalfieldids.md) | string\[\] | <i>(Optional)</i> List of field ids that should be rendered as hierarchical facets. | | ||
| [onlyRenderChildren?](./search-ui-react.facetsprops.onlyrenderchildren.md) | boolean | <i>(Optional)</i> 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?](./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. | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) > [@yext/search-ui-react](./search-ui-react.md) > [FacetsProps](./search-ui-react.facetsprops.md) > [onlyRenderChildren](./search-ui-react.facetsprops.onlyrenderchildren.md) | ||
|
||
## FacetsProps.onlyRenderChildren property | ||
|
||
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. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
onlyRenderChildren?: boolean; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) > [@yext/search-ui-react](./search-ui-react.md) > [FacetsProps](./search-ui-react.facetsprops.md) > [searchOnChange](./search-ui-react.facetsprops.searchonchange.md) | ||
|
||
## FacetsProps.searchOnChange property | ||
|
||
Whether or not a search is automatically run when a filter is selected. Defaults to true. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
searchOnChange?: boolean; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-ui-react](./search-ui-react.md) > [Geolocation\_2](./search-ui-react.geolocation_2.md) | ||
|
||
## Geolocation\_2() function | ||
|
||
A React Component which collects location information to create a location filter and perform a new search. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare function Geolocation({ geolocationOptions, radius, label, GeolocationIcon, handleClick, customCssClasses, }: GeolocationProps): JSX.Element | null; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| { geolocationOptions, radius, label, GeolocationIcon, handleClick, customCssClasses, } | [GeolocationProps](./search-ui-react.geolocationprops.md) | | | ||
|
||
<b>Returns:</b> | ||
|
||
JSX.Element \| null | ||
|
||
A react component for geolocation | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-ui-react](./search-ui-react.md) > [GeolocationCssClasses](./search-ui-react.geolocationcssclasses.md) > [button](./search-ui-react.geolocationcssclasses.button.md) | ||
|
||
## GeolocationCssClasses.button property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
button?: string; | ||
``` |
11 changes: 11 additions & 0 deletions
11
docs/search-ui-react.geolocationcssclasses.geolocationcontainer.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-ui-react](./search-ui-react.md) > [GeolocationCssClasses](./search-ui-react.geolocationcssclasses.md) > [geolocationContainer](./search-ui-react.geolocationcssclasses.geolocationcontainer.md) | ||
|
||
## GeolocationCssClasses.geolocationContainer property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
geolocationContainer?: string; | ||
``` |
11 changes: 11 additions & 0 deletions
11
docs/search-ui-react.geolocationcssclasses.iconcontainer.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-ui-react](./search-ui-react.md) > [GeolocationCssClasses](./search-ui-react.geolocationcssclasses.md) > [iconContainer](./search-ui-react.geolocationcssclasses.iconcontainer.md) | ||
|
||
## GeolocationCssClasses.iconContainer property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
iconContainer?: string; | ||
``` |
Oops, something went wrong.