UNPKG

@empathyco/x-components

Version:
79 lines (36 loc) 1.16 kB
<!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [Suggestion](./x-types.suggestion.md) ## Suggestion interface A suggestion represents a query that has been proposed to the user, due of being popular, matching with the current search query... **Signature:** ```typescript export interface Suggestion extends NamedModel<'QuerySuggestion' | 'PopularSearch'>, Previewable ``` **Extends:** [NamedModel](./x-types.namedmodel.md)<!-- -->&lt;'QuerySuggestion' \| 'PopularSearch'&gt;, [Previewable](./x-types.previewable.md) ## Properties <table><thead><tr><th> Property </th><th> Modifiers </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td> [isCurated?](./x-types.suggestion.iscurated.md) </td><td> </td><td> boolean </td><td> _(Optional)_ If it's a curated suggestion. </td></tr> <tr><td> [key](./x-types.suggestion.key.md) </td><td> </td><td> string </td><td> Unique identifier of the suggestion. </td></tr> </tbody></table>