Coveo ResultLayoutSelector Component (CoveoResultLayoutSelector)

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.

Available since

February 2018 Release (v2.3826.10)

Index

Methods

changeLayout

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

getCurrentLayout

  • getCurrentLayout(): "list" | "card" | "table"

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 different components. Mainly used by ResultLink.

componentStateModel

componentStateModel: ComponentStateModel

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.

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.

Static ID

ID: string

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

Accessors

usageAnalytics

Component Options

desktopLayouts

desktopLayouts: string[] | ("list" | "card" | "table")[]

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.

Default

[list, card, table]

mobileLayouts

mobileLayouts: string[] | ("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.

Default

[card, table]

tabletLayouts

tabletLayouts: string[] | ("list" | "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.

Default

[list, card, table]

Constructors

constructor