@empathyco/x-components
Version:
Empathy X Components
59 lines • 1.62 kB
TypeScript
/**
* Configuration options for the {@link QuerySuggestionsXModule}.
*
* @public
*/
export interface QuerySuggestionsConfig {
/**
* Debounce time measured in milliseconds used to store the query suggestions module query while
* the user is typing a query.
*/
debounceInMs: number;
/**
* Maximum number of query suggestions to request.
*/
maxItemsToRequest: number;
/**
* Hides the suggestion if it is equal to the current query.
*
* @example
* When set to true:
* ```
* query = 'trousers';
* suggestions = ['trousers', 'trousers skinny', 'trousers straight']
* // Suggests ['trousers skinny', 'trousers straight']
* ```
*
* @example
* When set to false:
* ```
* query = 'trousers';
* suggestions = ['trousers', 'trousers skinny', 'trousers straight']
* // Suggests ['trousers', 'trousers skinny', 'trousers straight']
* ```
*/
hideIfEqualsQuery: boolean;
/**
* Hides the query suggestions if it has been already searched during the session.
*
* @example
* When set to true:
* ```
* query = 'shorts';
* query = 'trousers';
* suggestions = ['t-shirt', 'shorts', 'dress']
* // Suggests ['t-shirt', 'dress']
* ```
*
* @example
* When set to false:
* ```
* query = 'shorts';
* query = 'trousers';
* suggestions = ['t-shirt', 'shorts', 'dress']
* // Suggests ['t-shirt', 'shorts', 'dress']
* ```
*/
hideSessionQueries: boolean;
}
//# sourceMappingURL=config.types.d.ts.map