BoxExpandLink Component

The BoxExpandLink component takes care of creating a clickable link that expands to a full search interface page. It also takes care of sending the current state of the Box component to the full search interface so that you get the same (or a similar) result set when the full search page loads.

Options

uri

Specifies the URI of the full search page to load when the user expands the Box.

Most of the time, you don’t have to specify a value manually for this option. The Box Visualforce Component already takes care of setting this option correctly.

<div data-uri='https://mysalesforce.na15.visual.force.com/apex/CoveoSearch'></div>

title

Specifies the title to display in the tab or subtab that opens inside the Salesforce console when the user clicks the component to expand the Box (see the toPrimaryTab option).

The default value is the localized string for Coveo Search.

<div data-title='<MY_SEARCH_PAGE>'></div>

Where you can replace <MY_SEARCH_PAGE> by the title you want to display in the tab or subtab that opens inside the Salesforce console when the user clicks the component to expand the Box.

hd

Specifies the description to display when the full search page loads with a context filter.

The default value is the localized string for the Context field.

<div data-hd='Context'></div>

targetTab

Specifies the id of the Tab component to load in the full search page when the user expands the box.

The default value is undefined, and the component uses the current Tab component as its targetTab when the user expands the box to a full search page.

<div data-target-tab='<SOME_TAB_ID>'></div>

Where you can replace <SOME_TAB_ID> by the id of the Tab component to load in the full search page when the user expands the Box.

icon

Specifies the CSS class of the icon to display on the expand button (see the text option).

The default value is coveo-icon coveo-sprites-box-icon_external.

<div data-icon='<MY_CSS_CLASS>'></div>

Where you can replace <MY_CSS_CLASS> by the CSS class of the icon to display on the expand button.

toPrimaryTab

Specifies whether to open the full search page as a primary or as a subtab inside the Salesforce console (see the title option).

The default value is true.

Setting this option to false makes the full search page open as a subtab inside the Salesforce console.

<div data-to-primary-tab='true'></div>

text

Specifies the text content to add inside the icon HTML element (see the icon option).

The default value is the localized string for GoToFullSearch.

<div data-text='<MY_TEXT_CONTENT>'></div>

Where you can replace <MY_TEXT_CONTENT> by the text content to add inside the icon HTML element.

Methods

This component doesn’t provide any methods.

Usage

You need to instantiate this component on an anchor HTML element.

<a class="CoveoBoxExpandLink" target="_blank"></a>
What's Next for Me?