Coveo YouTubeThumbnail Component (CoveoYouTubeThumbnail)

The YouTubeThumbnail component automatically fetches the thumbnail of a YouTube video.

This component differs from the standard Thumbnail component because the thumbnail it outputs is always clickable.

Depending on the component configuration, clicking a YouTube thumbnail can either automatically open a modal box containing the iframe from YouTube, or open the target URL in the current window (see YouTubeThumbnail.options.embed).

This component is a result template component (see Result Templates).

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

openResultLink

  • openResultLink(): void
  • Open the result link embedded in this component.

    With a standard configuration of this component, this will open an iframe that automatically plays the video.

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

embed

embed: boolean

Specifies whether clicking on the YouTube thumbnail loads the video in a modal box.

Setting this option to false causes the browser to change its current location to that of the target URL when the end user clicks the YouTube thumbnail.

Default value is true.

Default

true

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

height

height: string

Specifies the height (in pixels) of the YouTube thumbnail.

Default value is 112px.

Default

112px

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

width

width: string

Specifies the width (in pixels) of the YouTube thumbnail.

Default value is 200px.

Default

200px

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

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 YouTubeThumbnail