Coveo FacetsMobileMode Component (CoveoFacetsMobileMode)

This component lets you customize the mobile responsive behavior of facets in your search interface.

Notes:

  • You can include this component anywhere under the root element of your search interface.
  • You should only include this component once in your search interface.
  • If you do not include this component in your search interface, facets will still have a default mobile responsive behavior.

Index

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

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

breakpoint

breakpoint: number

The screen width (in number of pixels) at which facets should enter mobile responsive mode and be collapsed under a single button.

Default: 800

Markup configuration example(s) :
data-breakpoint='10'

displayOverlayWhileOpen

displayOverlayWhileOpen: boolean

Whether to display an overlay behind the facets when the end user expands them in mobile responsive mode.

By default, the following behavior applies:

Markup configuration example(s) :
data-display-overlay-while-open='true'
data-display-overlay-while-open='false'

isModal

isModal: boolean

Whether to display the facets in a modal instead of a pop-up when the end user expands them in mobile responsive mode.

Default

false

Markup configuration example(s) :
data-is-modal='true'
data-is-modal='false'

preventScrolling

preventScrolling: boolean

Whether to disable vertical scrolling on the specified or resolved scrollContainer while facets are expanded in mobile responsive mode.

By default, the following behavior applies:

Markup configuration example(s) :
data-prevent-scrolling='true'
data-prevent-scrolling='false'

scrollContainer

scrollContainer: HTMLElement

The HTML element whose vertical scrolling should be locked while facets are expanded in mobile responsive mode.

By default, the component tries to detect and use the first ancestor element whose CSS overflow-y attribute is set to scroll, starting from the FacetsMobileMode's element itself. If no such element is found, the document.body element is used.

Since this heuristic is not perfect, we strongly recommend that you manually set this option by explicitly specifying the desired CSS selector.

Example: data-scroll-container-selector='#someCssSelector'

Only effective when

preventScrolling is set to true

Constructors

constructor

  • Create a new Component. Resolve all IComponentBindings if not provided.
    Create a new Logger for this component. Attach the component to the SearchInterface.

    Parameters

    • element: HTMLElement

      The HTMLElement on which to create the component. Used to bind data on the element.

    • type: string

      The unique identifier for this component. See: IComponentDefinition.ID. Used to generate the unique Coveo CSS class associated with every component.

    • Default value bindings: IComponentBindings = {}

      The environment for every component. Optional, but omitting to provide one will impact performance.

    Returns FacetsMobileMode