Changes the current layout.
Also logs a resultLayoutChange event in the usage analytics with the new layout as metadeta.
Triggers a new query.
The new layout. The page must contain a valid ResultList component with a matching ResultList.options.layout value for this method to work.
Return the debug info about this component.
Disable the component. Normally this means that the component will not execute handlers for the framework events (query events, for example). Components are enabled by default on creation.
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.
Return the bindings, or environment, for the current component.
Gets the current layout (list, card or table).
The current current layout.
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.
HTMLElement for which to get the bound component.
Optional component class. If the HTMLElement has multiple components bound, you must specify which one you are targeting.
Boolean option to tell the method to not throw on error.
Allows the component to bind events and execute them only when it is enabled.
Contains the state of options for different components. Mainly used by ResultLink.
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events.
A disabled component will not participate in the query, or listen to ComponentEvents.
Allows component to log in the dev console.
Contains the singleton that allows to trigger queries.
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
A reference to the root HTMLElement (the SearchInterface).
A reference to the root of every component, the SearchInterface.
The static ID that each component needs in order to be identified.
For example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
Specifies the layouts that should be available when the search page is displayed in desktop mode.
By default, the desktop mode breakpoint is any screen size over 800 px.
To change this default value, use the responsiveMediumBreakpoint option.
When the breakpoint is reached, layouts that are not specified becomes inactive and the linked result list will be disabled.
The possible values for layouts are list, card, table.
The default value is list, card, table.
Specifies the layouts that should be available when the search page is displayed in mobile mode.
By default, the mobile mode breakpoint is at 480 px screen width.
To change this default value, use the responsiveSmallBreakpoint option.
When the breakpoint is reached, layouts that are not specified becomes inactive and the linked result list will be disabled.
The possible values for layouts are list, card, table.
The default value is card, table.
Specifies the layouts that should be available when the search page is displayed in tablet mode.
By default, the tablet mode breakpoint is at 800 px screen width.
To change this default value, use the responsiveMediumBreakpoint option.
When the breakpoint is reached, layouts that are not specified becomes inactive and the linked result list will be disabled.
The possible values for layouts are list, card, table.
The default value is list, card, table.
Creates a new ResultLayoutSelector component.
The HTMLElement on which to instantiate the component.
The options for the ResultLayout component.
The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).
The ResultLayoutSelector component allows the end user to switch between multiple ResultList components that have different ResultList.options.layout values.
This component automatically populates itself with buttons to switch between the ResultList components that have a valid layout value (see the ValidLayout type).
See also the Result Layouts documentation.
February 2018 Release (v2.3826.10)