-
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.
feat(custom): update onDropdownInputSelect prop to replace default be…
…havior, add documentation specify a type for the props passed into onDropdownInputSelect and pass back the searchFields used in the FilterSearch component so we can properly remove/keep the right filters J=BACK-2765 TEST=manual
- Loading branch information
1 parent
ac20087
commit 5545f1f
Showing
12 changed files
with
146 additions
and
28 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
13 changes: 13 additions & 0 deletions
13
docs/search-ui-react.ondropdowninputchangeprops.executefiltersearch.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) > [OnDropdownInputChangeProps](./search-ui-react.ondropdowninputchangeprops.md) > [executeFilterSearch](./search-ui-react.ondropdowninputchangeprops.executefiltersearch.md) | ||
|
||
## OnDropdownInputChangeProps.executeFilterSearch property | ||
|
||
A function that executes a filter search and updates the input and dropdown options with the response. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
executeFilterSearch: (query?: string) => Promise<FilterSearchResponse | undefined>; | ||
``` |
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) > [OnDropdownInputChangeProps](./search-ui-react.ondropdowninputchangeprops.md) | ||
|
||
## OnDropdownInputChangeProps interface | ||
|
||
The parameters that are passed into [FilterSearchProps.onDropdownInputChange](./search-ui-react.filtersearchprops.ondropdowninputchange.md)<!-- -->. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
interface OnDropdownInputChangeProps | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Modifiers | Type | Description | | ||
| --- | --- | --- | --- | | ||
| [executeFilterSearch](./search-ui-react.ondropdowninputchangeprops.executefiltersearch.md) | | (query?: string) => Promise<FilterSearchResponse \| undefined> | A function that executes a filter search and updates the input and dropdown options with the response. | | ||
| [searchFields](./search-ui-react.ondropdowninputchangeprops.searchfields.md) | | Omit<SearchParameterField, 'fetchEntities'>\[\] | | | ||
| [value](./search-ui-react.ondropdowninputchangeprops.value.md) | | string | The new input element's new value after the change | | ||
|
11 changes: 11 additions & 0 deletions
11
docs/search-ui-react.ondropdowninputchangeprops.searchfields.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) > [OnDropdownInputChangeProps](./search-ui-react.ondropdowninputchangeprops.md) > [searchFields](./search-ui-react.ondropdowninputchangeprops.searchfields.md) | ||
|
||
## OnDropdownInputChangeProps.searchFields property | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
searchFields: Omit<SearchParameterField, 'fetchEntities'>[]; | ||
``` |
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) > [OnDropdownInputChangeProps](./search-ui-react.ondropdowninputchangeprops.md) > [value](./search-ui-react.ondropdowninputchangeprops.value.md) | ||
|
||
## OnDropdownInputChangeProps.value property | ||
|
||
The new input element's new value after the change | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
value: 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
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