CategorySearch
CategorySearch
creates a category based data search UI component with an autosuggest functionality. It is used for applying full-text search across one or more fields.
Example uses:
- Searching for a rental listing by its
name
ordescription
field. - Creating an e-commerce search box for finding products by their listing properties.
Usage
Basic Usage
<CategorySearch
componentId="SearchSensor"
dataField={["group_venue", "group_city"]}
categoryField="group_topics"
/>
Usage With All Props
<CategorySearch
componentId="SearchSensor"
dataField={["group_venue", "group_city"]}
categoryField="group_topics"
title="Search"
defaultValue={{
term: 'Paris',
category: '*'
}}
fieldWeights={[1, 3]}
placeholder="Search for cities or venues"
autoSuggest={true}
defaultSuggestions={[{label: "Programming", value: "Programming"}]}
highlight={false}
highlightField="group_city"
queryFormat="or"
fuzziness={0}
debounce={100}
react={{
and: ["CategoryFilter", "SearchFilter"]
}}
showFilter={true}
filterLabel="Venue filter"
URLParams={false}
/>
Props
- componentId
String
unique identifier of the component, can be referenced in other components’react
prop. - dataField
String or Array
data field(s) on which the search query will be applied to. If you want to search across multiple fields, pass them as anArray
. - nestedField
String
[optional] use to set thenested
mapping field that allows arrays of objects to be indexed in a way that they can be queried independently of each other. Applicable only when dataField is a part ofnested
type. - categoryField
String
[optional] data field which has the category values mapped. - title
String or JSX
[optional] Sets the title of the component to be shown in the UI. - defaultValue
Object
[optional] set the initial search query text on mount & the category. -
value
Object
[optional] controls the current value of the component. It sets the search query text & the category (on mount and on update). Use this prop in conjunction withonChange
function. Usage:<CategorySearch {...searchProps} value={{ term: 'Harry', category: '*', }} />
-
onChange
function
[optional] is a callback function which accepts component’s current value as a parameter. It is called when you are using thevalue
prop and the component’s value changes. This prop is used to implement the controlled component behavior.<CategorySearch value={this.state.value} onChange={(value, triggerQuery, event) => { this.setState({ value, }, () => triggerQuery()) }} />
Note:
If you’re using the controlled behavior than it’s your responsibility to call the
triggerQuery
method to update the query i.e execute the search query and update the query results in connected components byreact
prop. It is not mandatory to call thetriggerQuery
inonChange
you can also call it in other input handlers likeonBlur
oronKeyPress
. - downShiftProps
Object
[optional] allow passing props directly toDownshift
component. You can read more about Downshift props here. - fieldWeights
Array
[optional] set the search weight for the database fields, useful when dataField is an Array of more than one field. This prop accepts an array of numbers. A higher number implies a higher relevance weight for the corresponding field in the search results. - placeholder
String
[optional] Sets the placeholder text to be shown in the searhbox input field. Defaults to “Search”. - showIcon
Boolean
[optional] whether to display a search or custom icon in the input box. Defaults totrue
. - iconPosition
String
[optional] sets the position of the search icon. Can beleft
orright
. Defaults toright
. - icon
JSX
[optional] displays a custom search icon instead of the default 🔍 - showClear
Boolean
[optional] show a clear text icon. Defaults tofalse
. - clearIcon
JSX
[optional] allows setting a custom icon for clearing text instead of the default cross. - autosuggest
Boolean
[optional] set whether the autosuggest functionality should be enabled or disabled. Defaults totrue
. - strictSelection
Boolean
[optional] defaults tofalse
. When set totrue
the component will only set its value and fire the query if the value was selected from the suggestion. Otherwise the value will be cleared on selection. This is only relevant withautosuggest
. - defaultSuggestions
Array
[optional] preset search suggestions to be shown on focus when the search box does not have any search query text set. Accepts an array of objects each having a label and value property. The label can contain either String or an HTML element. - debounce
Number
[optional] sets the milliseconds to wait before executing the query. Defaults to0
, i.e. no debounce. - highlight
Boolean
[optional] Whether highlighting should be enabled in the returned results. Defaults tofalse
. - highlightField
String
orArray
[optional] When highlighting is enabled, this prop allows specifying the fields which should be returned with the matching highlights. When not specified, it defaults to applying highlights on the field(s) specified in the dataField prop. - customHighlight
Function
[optional] a function which returns the custom highlight settings. It receives theprops
and expects you to return an object with thehighlight
key. Check out the technews demo where theDataSearch
component uses acustomHighlight
as given below,
<CategorySearch
componentId="title"
dataField={['title', 'text']}
highlight
customHighlight={(props) => ({
highlight: {
pre_tags: ['<mark>'],
post_tags: ['</mark>'],
fields: {
text: {},
title: {},
},
number_of_fragments: 0,
},
})}
/>
-
queryFormat
String
[optional] Sets the query format, can be or or and. Defaults to or.- or returns all the results matching any of the search query text’s parameters. For example, searching for “bat man” with or will return all the results matching either “bat” or “man”.
- On the other hand with and, only results matching both “bat” and “man” will be returned. It returns the results matching all of the search query text’s parameters.
- fuzziness
String or Number
[optional] Sets a maximum edit distance on the search parameters, can be 0, 1, 2 or “AUTO”. Useful for showing the correct results for an incorrect search parameter by taking the fuzziness into account. For example, with a substitution of one character, fox can become box. Read more about it in the elastic search docs. - showFilter
Boolean
[optional] show as filter when a value is selected in a global selected filters view. Defaults totrue
. - showVoiceSearch
Boolean
[optional] show an option in search bar to enable the voice to text search. Defaults tofalse
. - searchOperators
Boolean
[optional] Defaults tofalse
, if set totrue
than you can use special characters in the search query to enable the advanced search.
Read more about it here. - filterLabel
String
[optional] An optional label to display for the component in the global selected filters view. This is only applicable ifshowFilter
is enabled. Default value used here iscomponentId
. - URLParams
Boolean
[optional] enable creating a URL query string parameter based on the current value of the search. This is useful for sharing URLs with the component state. Defaults tofalse
. -
render
Function
[optional] You can render custom suggestions by usingrender
prop.
It accepts an object with these properties:loading
:boolean
indicates that the query is still in progresserror
:object
An object containing the error infodata
:array
An array of parsed suggestions (original suggestions + category suggestions) obtained from the applied query.categories
:array
An array of parsed category suggestions.rawCategories
:array
An array of original category suggestions.suggestions
:array
An array of parsed suggestions.rawSuggestions
:array
An array of original suggestions.value
:string
current search input value i.e the search query being used to obtain categories and suggestions.-
downshiftProps
:object
provides all the control props fromdownshift
which can be used to bind list items with click/mouse events. Read more about it here.<CategorySearch render={({ loading, error, value, categories, suggestions, downshiftProps: { isOpen, getItemProps, } }) => { if(loading) { return <div>Fetching Suggestions.</div> } if(error) { return ( <div> Something went wrong! Error details {JSON.stringify(error)} </div> ) } return (isOpen && Boolean(value.length)) ? ( <div> {suggestions.slice(0, 5).map((suggestion, index) => ( <div key={suggestion.value} {...getItemProps({ item: suggestion })} > {suggestion.value} </div> ))} {categories.slice(0, 3).map((category, index) => ( <div key={category.key} {...getItemProps({ item: { value: value, category: category.key } })} > {value} in {category.key} </div> ))} {Boolean(value.length) && ( <div {...getItemProps({ item: { label: value, value: value }})} > Search for "{value}" in all categories </div> )} </div> ) : null }} />
Or you can also use render function as children
<CategorySearch> { ({ loading, error, data, categories, rawCategories, suggestions, rawSuggestions value, downshiftProps }) => ( // return custom suggestions UI to be rendered ) } </CategorySearch>
-
renderError
String or JSX or Function
[optional] can we used to render an error message in case of any error.renderError={(error) => ( <div> Something went wrong!<br/>Error details<br/>{error} </div> ) }
-
renderNoSuggestion
String or JSX or Function
[optional] can we used to render a message when there is no suggestions found.renderNoSuggestion={() => ( <div> No suggestions found </div> ) }
- getMicInstance
Function
[optional] You can pass a callback function to get the instance ofSpeechRecognition
object, which can be used to override the default configurations. -
renderMic
String or JSX or Function
[optional] can we used to render the custom mic option.
It accepts an object with the following properties:handleClick
:function
needs to be called when the mic option is clicked.-
status
:string
is a constant which can have one of these values:
INACTIVE
- mic is in inactive state i.e not listening
STOPPED
- mic has been stopped by the user
ACTIVE
- mic is listening
DENIED
- permission is not allowedrenderMic = {({ handleClick, status }) => { switch(status) { case 'ACTIVE': return <img src="/active_mic.png" onClick={handleClick} /> case 'DENIED': case 'STOPPED': return <img src="/mute_mic.png" onClick={handleClick} /> default: return <img src="/inactive_mic.png" onClick={handleClick} /> } }}
- onSuggestions
Function
[optional] You can pass a callback function to listen for the changes in suggestions.The function receivessuggestions
list. - onError
Function
[optional] gets triggered in case of an error and provides theerror
object, which can be used for debugging or giving feedback to the user if needed.
Demo
Styles
CategorySearch
component supports innerClass
prop with the following keys:
title
input
list
mic
Read more about it here.
Extending
CategorySearch
component can be extended to
- customize the look and feel with
className
,style
, - update the underlying DB query with
customQuery
, - connect with external interfaces using
beforeValueChange
,onValueChange
,onValueSelected
andonQueryChange
, - specify how search suggestions should be filtered using
react
prop, - use your own function to render suggestions using
parseSuggestion
prop. It expects an object back for eachsuggestion
having keyslabel
andvalue
. The query is run against thevalue
key andlabel
is used for rendering the suggestions.label
can be eitherString
or JSX. For example,
<CategorySearch
...
parseSuggestion={(suggestion) => ({
label: (
<div>
{suggestion._source.original_title} by
<span style={{ color: 'dodgerblue', marginLeft: 5 }}>
{suggestion._source.authors}
</span>
</div>
),
value: suggestion._source.original_title,
source: suggestion._source // for onValueSelected to work with parseSuggestion
})}
/>
-
it’s also possible to take control of rendering individual suggestions with
parseSuggestion
prop or the entire suggestions rendering using therender
prop. Check the custom suggestions recipe for more info. -
add the following synthetic events to the underlying
input
element:- onBlur
- onFocus
- onKeyPress
- onKeyDown
- onKeyUp
- autoFocus
Note:
All these events accepts the
triggerQuery
as a second parameter which can be used to trigger theCategorySearch
query with the current selected value (useful to customize the search query execution).
<CategorySearch
...
className="custom-class"
style={{"paddingBottom": "10px"}}
customQuery={
function(value, props, category) {
return {
query: {
match: {
data_field: "this is a test"
}
}
}
}
}
beforeValueChange={
function(value) {
// called before the value is set
// returns a promise
return new Promise((resolve, reject) => {
// update state or component props
resolve()
// or reject()
})
}
}
onValueChange={
function(value) {
console.log("current value: ", value)
// set the state
// use the value with other js code
}
}
onValueSelected={
function(value, category, cause, source) {
console.log("current value and category: ", value, category)
}
}
onQueryChange={
function(prevQuery, nextQuery) {
// use the query with other js code
console.log('prevQuery', prevQuery);
console.log('nextQuery', nextQuery);
}
}
// specify how and which suggestions are filtered using `react` prop.
react={
"and": ["pricingFilter", "dateFilter"],
"or": ["searchFilter"]
}
/>
- className
String
CSS class to be injected on the component container. - style
Object
CSS styles to be applied to the CategorySearch component. - customQuery
Function
takes value, props and category as parameters and returns the data query to be applied to the component, as defined in Elasticsearch Query DSL.Note:
customQuery is called on value changes in the CategorySearch component as long as the component is a part ofreact
dependency of at least one other component. - defaultQuery
Function
takes value, props and category as parameters and returns the data query to be applied to the source component, as defined in Elasticsearch Query DSL, which doesn’t get leaked to other components.
Read more about it here. - beforeValueChange
Function
is a callback function which accepts component’s future value as a parameter and returns a promise. It is called everytime before a component’s value changes. The promise, if and when resolved, triggers the execution of the component’s query and if rejected, kills the query execution. This method can act as a gatekeeper for query execution, since it only executes the query after the provided promise has been resolved. - onValueChange
Function
is a callback function which accepts component’s current value as a parameter. It is called everytime the component’s value changes. This prop is handy in cases where you want to generate a side-effect on value selection. For example: You want to show a pop-up modal with the valid discount coupon code when a user searches for a product in a CategorySearch. -
onValueSelected
Function
is called with the value and the category selected via user interaction. If the search was performed by selecting the ‘in all categories’ suggestion, category is received as*
. If it was performed for one of the categorized suggestion, thecategory
is received. In other cases (either searching without selecting a suggestion or picking an uncategorized suggestion),category
is received asnull
. It works only withautosuggest
and is called whenever a suggestion is selected or a search is performed by pressing enter key. It also passes thecause
of action and thesource
object if the cause of action was'SUGGESTION_SELECT'
. The source would benull
if a category based suggestion was selected. The possible causes are:'SUGGESTION_SELECT'
'ENTER_PRESS'
- `‘CLEAR_VALUE’
- onQueryChange
Function
is a callback function which accepts component’s prevQuery and nextQuery as parameters. It is called everytime the component’s query changes. This prop is handy in cases where you want to generate a side-effect whenever the component’s query would change. -
react
Object
specify dependent components to reactively update CategorySearch’s suggestions.-
key
String
one ofand
,or
,not
defines the combining clause.- and clause implies that the results will be filtered by matches from all of the associated component states.
- or clause implies that the results will be filtered by matches from at least one of the associated component states.
- not clause implies that the results will be filtered by an inverse match of the associated component states.
-
value
String or Array or Object
String
is used for specifying a single component by itscomponentId
.Array
is used for specifying multiple components by theircomponentId
.Object
is used for nesting other key clauses.
-