Coveo SmartSnippet Component (CoveoSmartSnippet)

The SmartSnippet component displays the excerpt of a document that would be most likely to answer a particular query.

This excerpt can be visually customized using inline styling.

Index

Methods

Properties

Accessors

Component Options

Constructors

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

bind: ComponentEvents

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

alwaysOpenInNewWindow

alwaysOpenInNewWindow: boolean

Specifies whether the component should open its links in a new window instead of opening them in the current context.

Default value is false.

Default

false

Markup configuration example(s) :
data-always-open-in-new-window='true'
data-always-open-in-new-window='false'

hrefTemplate

hrefTemplate: string

Specifies a template literal from which to generate the title and URI's href attribute value (see Template literals).

This option overrides the [field]{@link SmartSnippet.options.uriField} option value.

The template literal can reference any number of fields from the parent result. It can also reference global scope properties.

Examples:

  • The following markup generates an href value such as http://uri.com?id=itemTitle:
<a class='CoveoSmartSnippet' data-href-template='${clickUri}?id=${raw.title}'></a>
  • The following markup generates an href value such as localhost/fooBar:
<a class='CoveoSmartSnippet' data-href-template='${window.location.hostname}/{Foo.Bar}'></a>

Default value is undefined.

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

maximumSnippetHeight

maximumSnippetHeight: number

The maximum height an answer can have in pixels. Any part of an answer exceeding this height will be hidden by default and expendable via a "show more" button. Default value is 250.

Minimum

0

Default

250

Markup configuration example(s) :
data-maximum-snippet-height='10'

titleField

titleField: IFieldOption

The field to display for the title.

Default

@title

Markup configuration example(s) :
data-title-field='@foo'

useIFrame

useIFrame: boolean

Specify if the SmartSnippet should be displayed inside an iframe or not.

Use this option in specific cases where your environment has limitations around iframe usage.

Examples:

<div class='CoveoSmartSnippet' data-use-i-frame='true'></div>

Default value is true.

Default

true

Markup configuration example(s) :
data-use-i-frame='true'
data-use-i-frame='false'

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 SmartSnippet