Support Menu

Coveo component FieldSuggestions

The FieldSuggestions component provides query suggestions based on a particular facet field. For example, you could use this component to provide auto-complete suggestions while the end user is typing a document title.

The query suggestions that this component provides appear in the Omnibox component.

Index

Component Options

field

Specifies the field from which to provide suggestions.

Specifying a value for this option is required for the FieldSuggestions component to work.

Markup configuration example(s) :
data-field='@foo'

headerTitle

headerTitle: string

Specifies the title of the result suggestions group in the Omnibox component. This option is not available when using the default Lightning Friendly Theme (see Lightning Friendly Theme).

Default value is the localized string for "SuggestedResults".

Markup configuration example(s) :
data-header-title='foo'

numberOfSuggestions

numberOfSuggestions: number

Specifies the number of suggestions to render in the Omnibox.

Default value is 5. Minimum value is 1.

Markup configuration example(s) :
data-number-of-suggestions='10'

omniboxZIndex

omniboxZIndex: number

Specifies the z-index position at which the suggestions render themselves in the Omnibox.

When there are multiple suggestion providers (e.g., Facet or AnalyticsSuggestions), components with a higher omniboxZIndex values render themselves first.

Default value is 51. Minimum value is 0.

Markup configuration example(s) :
data-omnibox-z-index='10'

onSelect

onSelect: ISuggestionForOmniboxOptionsOnSelect

Specifies the event handler function to execute when the end user selects a suggested value un the Omnibox. By default, the query box text is replaced by what the end user selected and a new query is executed. You can, however, replace this default behavior by providing a callback function to execute when the value is selected.

You can only set this option in the init call of your search interface. You cannot set it directly in the markup as an HTML attribute.

Example:

// You can call the init script using "pure" JavaScript:
Coveo.init(document.querySelector('#search'), {
   FieldSuggestions : {
     omniboxSuggestionOptions : {
       onSelect : function(valueSelected, populateOmniBoxEventArgs){
         // Do something special when a value is selected.
         // You receive the selected value as the first argument, and the Omnibox object as the second argument.
       }
     }
   }
})

// Or you can call the init script using the jQuery extension:
$('#mySearch').coveo('init', {
   FieldSuggestions : {
     omniboxSuggestionOptions : {
       onSelect : function(valueSelected, populateOmniBoxEventArgs){
         // Do something special when a value is selected.
         // You receive the selected value as the first argument, and the Omnibox object as the second argument.
       }
     }
   }
})

queryOverride

queryOverride: string

Specifies a query override to apply when retrieving suggestions. You can use any valid query expression (see Coveo Query Syntax Reference).

Default value is '', which means that the component applies no query override by default.

Markup configuration example(s) :
data-query-override='foo'

Methods

debugInfo

  • debugInfo(): any

disable

  • disable(): void
  • Disable the component. Normally this means that the component will not execute handlers for the framework events (query events, for example). Component are enabled by default on creation.

    Returns void

enable

  • enable(): void
  • Enable the component. Normally this means that the component will execute handlers for the framework events (query events, for example). Components are enabled by default on creation.

    Returns void

getBindings

selectSuggestion

  • selectSuggestion(suggestion: any): void
  • Selects a currently displayed query suggestion. This implies that at least one suggestion must have been returned at least once.

    Parameters

    • suggestion: any

      Either a number (0-based index position of the query suggestion to select) or a string that matches the suggestion to select.

    Returns void

Static get

  • get(element: HTMLElement, componentClass?: any, noThrow?: boolean): BaseComponent
  • Get the bound component to the given HTMLElement. Throws an assert if the HTMLElement has no component bound, unless using the noThrow argument.
    If there is multiple component bound to the current HTMLElement, you must specify the component class.

    Parameters

    • element: HTMLElement

      HTMLElement for which to get the bound component.

    • Optional componentClass: any

      Optional component class. If the HTMLElement has multiple components bound, you must specify which one you are targeting.

    • Optional noThrow: boolean

      Boolean option to tell the method to not throw on error.

    Returns BaseComponent

Properties

bind

Allows the component to bind events and execute them only when it is enabled.

type

{Coveo.ComponentEvents}

componentOptionsModel

componentOptionsModel: ComponentOptionsModel

Contains the state of options for differents component. Mainly used by ResultLink.

componentStateModel

componentStateModel: ComponentStateModel

Contains the state of different component (enabled vs disabled). Allows to get/set values. Trigger component state event when modified. Each component can listen to those events.

disabled

disabled: boolean

A disabled component will not participate in the query, or listen to ComponentEvents.

type

{boolean}

logger

logger: Logger

Allows component to log in the dev console.

queryController

queryController: QueryController

Contains the singleton that allows to trigger queries.

queryStateModel

queryStateModel: QueryStateModel

Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.

root

root: HTMLElement

A reference to the root HTMLElement (the SearchInterface).

searchInterface

searchInterface: SearchInterface

A reference to the root of every component, the SearchInterface.

usageAnalytics

usageAnalytics: IAnalyticsClient

A reference to the Analytics.client.

Static ID

ID: string

The static ID that each component need to be identified.
For example, SearchButton -> static ID : SearchButton -> className : CoveoSearchButton

Constructors

constructor

  • Creates a new FieldSuggestions component.

    Parameters

    • element: HTMLElement

      The HTMLElement on which to instantiate the component.

    • options: IFieldSuggestionsOptions

      The options for the FieldSuggestions component.

    • Optional bindings: IComponentBindings

      The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).

    Returns FieldSuggestions