Coveo TemplateLoader Component (CoveoTemplateLoader)

The TemplateLoader component can load one result template into another. You should normally declare any reusable result template outside of the ResultList component. Otherwise, the framework will evaluate the data-condition of the reusable result template and possibly render it.

Example:

[ ... ]

<!-- A reusable result template. Note that it is important to declare it outside of the ResultList component. -->
<script type='text/underscore' class='result-template' id='ReusableTemplate'>
  <table class='CoveoFieldTable'>
    <tr data-field='@source' data-caption='Source'></tr>
    <tr data-field='@percentScore' data-caption='Score'></tr>
  </table>
</script>

[ ... ]

<div class="CoveoResultList" data-wait-animation="fade" data-auto-select-fields-to-include="true">

  <!-- A custom result template for Lithium messages. -->
  <script type='text/underscore' class='result-template' data-condition='raw.filetype == "lithiummessage"'>
    <div>
      <img class='CoveoIcon' data-small='true'>
      <a class='CoveoResultLink'></a>
      <div class='CoveoTemplateLoader' data-template-id='ReusableTemplate'></div>
    </div>
  </script>

  <!-- A custom result template for images. -->
  <script type='text/underscore' class='result-template' data-condition='raw.filetype == "Image"'>
    <div>
      <img class='CoveoIcon' data-small='true'></img>
        <a class='CoveoResultLink'>
          <img class='CoveoThumbnail'>
        </a>
      <div class='CoveoTemplateLoader' data-template-id='ReusableTemplate'></div>
    </div>
  </script>
</div>

[ ... ]

See Result Templates.

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

condition

condition: string

Specifies the boolean condition that the result must satisfy in order for the template to load.

Example:

data-condition='percentScore > 80'

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

template

template: Template

Specifies how to find the template. This can be either a CSS selector or an HTML id attribute.

Examples:

  • With a CSS selector: data-template-selector='.MySelector'
  • With an HTML id: data-template-id='MyId'

Constructors

constructor

  • Creates a new TemplateLoader.

    Parameters

    • element: HTMLElement

      The HTMLElement on which to instantiate the component.

    • Optional options: ITemplateLoaderOptions

      The options for the TemplateLoader component.

    • Optional bindings: IComponentBindings

      The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).

    • Optional result: IQueryResult

      The result to associate the component with.

    Returns TemplateLoader