Support Menu

Coveo component Searchbox

The Searchbox component can conveniently create two components that are frequently used together to allow the end user to input and submit queries.

This component attaches itself to a div element and takes care of instantiating either a Querybox component or an Omnibox component, depending on its configuration. Optionally, the Searchbox component can also instantiate a SearchButton component and append it inside the same div.

Index

Component Options

addSearchButton

addSearchButton: boolean

Specifies whether to instantiate a SearchButton component.

Default value is true.

Markup configuration example(s) :
data-add-search-button='true'
data-add-search-button='false'

enableOmnibox

enableOmnibox: boolean

Specifies whether to instantiate an Omnibox component.

When this option is false, the Searchbox component instantiates a Querybox component instead of an Omnibox component.

Note:

You can use configuration options specific to the component that the Searchbox instantiates.

Examples:

In this first case, the Searchbox will instantiate a Querybox component. It is therefore possible to configure that Querybox instance using any of the Querybox component options such as Querybox.options.triggerQueryOnClear.

<div class='CoveoSearchbox' data-trigger-query-on-clear='true'></div>

In this second case, the Searchbox will instantiate an Omnibox component. It is therefore possible to configure that Omnibox instance using any of the Omnibox component options such as Omnibox.options.placeholder. Moreover, since the Omnibox component inherits all of the Querybox component options, the data-trigger-query-on-clear option will also work on that Omnibox instance.

<div class='CoveoSearchbox' data-enableOmnibox='true' data-place-holder='Please enter a query'></div>

Default value is false.

Markup configuration example(s) :
data-enable-omnibox='true'
data-enable-omnibox='false'

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

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).

searchButton

searchButton: SearchButton

The SearchButton instance.

searchInterface

searchInterface: SearchInterface

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

searchbox

searchbox: Querybox | Omnibox

The instance of the component that allows the end user to input queries.

Can be either a Querybox component or an Omnibox component, depending on the value of Searchbox.options.enableOmnibox.

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 Searchbox. Creates a new Coveo.Magicbox instance and wraps magic box methods (on blur, on submit etc.). Binds event on buildingQuery and on redirection (for standalone box).

    Parameters

    • element: HTMLElement

      The HTMLElement on which to instantiate the component. This cannot be an HTMLInputElement for technical reasons.

    • Optional options: ISearchboxOptions

      The options for the Searchbox component. These will merge with the options from the component set directly on the HTMLElement.

    • 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 Searchbox