---
title: BoxExpandLink component (Deprecated)
slug: '1098'
canonical_url: https://docs.coveo.com/en/1098/
collection: coveo-for-salesforce
source_format: adoc
---
# BoxExpandLink component (Deprecated)
> **Deprecated**
>
> This feature is still available, but no longer supported as of the August 2023 release of Coveo for Salesforce version [5.2](https://docs.coveo.com/en/n5bj0150#august-2023-release-v5-2-initial-release).

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](https://docs.coveo.com/en/1103/) already takes care of setting this option correctly.

```html
<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`](https://docs.coveo.com/en/1098#toprimarytab) option).

The default value is the localized string for `Coveo Search`.

```xml
<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.

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

### targetTab

Specifies the [`id`](https://coveo.github.io/search-ui/components/tab.html#options.id-1) of the [`Tab`](https://coveo.github.io/search-ui/components/tab.html) component to load on 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.

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

Where you can replace `<SOME_TAB_ID>` by the `id` of the `Tab` component to load on 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`](https://docs.coveo.com/en/1098#text) option).

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

```xml
<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`](https://docs.coveo.com/en/1098#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.

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

### text

Specifies the text content to add inside the icon HTML element (see the [`icon`](https://docs.coveo.com/en/1098#icon) option).

The default value is the localized string for `GoToFullSearch`.

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

This component must be instantiated on an `anchor` HTML element.

```xml
<a class="CoveoBoxExpandLink" target="_blank"></a>
```