---
title: Searchbox Lightning component (Obsolete)
slug: '1093'
canonical_url: https://docs.coveo.com/en/1093/
collection: coveo-for-salesforce
source_format: adoc
---
# Searchbox Lightning component (Obsolete)
> **Obsolete**
>
> This feature is no longer available as of the April 2020 release of Coveo for Salesforce version [4.2](https://docs.coveo.com/en/3236#april-2020-release-v4-2-initial-release).

The _Searchbox_ Lightning component allows you to change the search box in your Experience Cloud site.

It takes care of wrapping and including the correct scripts and different resource references needed to do so.

> **Note**
>
> For a tutorial on how to implement a custom search box component, see [Creating a custom standalone search box for your Experience Cloud site](https://docs.coveo.com/en/1245/).

## Usage

Reference it in your Lightning component as you would for any other Aura component, using the namespace prefix of the Coveo package.

```xml
<aura:component implements='forceCommunity:searchInterface'>
  <CoveoV2:Searchbox/>
</aura:component>
```

## Resources included with this component

This component includes the [Coveo JavaScript Search Framework](https://github.com/coveo/search-ui), the [jQuery](https://jquery.com/)(latest 3.x.x version) and [Underscore.js](http://underscorejs.org/) (latest 1.x.x version) libraries, and the Coveo for Salesforce specific assets.

## Aura event

This component offers the following Aura event:

### `GetSearchToken`

Fired when the search token has been fetched (see [Generating a custom search token for Coveo Lightning Aura components](https://docs.coveo.com/en/2745/)).

## Options

This components offers the following options:

### `name`

The name of the Visualforce component that should act as your search interface.

Depending on the Lightning component you're using, this could either be a search or a case creation Visualforce component.

Default value is `communityCoveo`.

### `searchHub`

The name of the searchHub to be sent to [Coveo Analytics](https://docs.coveo.com/en/182/).

This option should have the same value as `name`.

Default value is `communityCoveo`.

### `searchPageName`

The name of the community page your Coveo Search component is on.

This option doesn't have a default value.

To make it work, you need to enter the following value:

* **With Salesforce before Winter 18**: `search/all/home/%40uri`
* **With Salesforce Winter 18 and up (with up-to-date community)**: `global-search/%40uri`

### `placeholder`

The placeholder text to put in the searchbox when no query is typed.

This option doesn't have a default value.

### `enableQuerySuggestAddon`

Specifies whether to enable [Coveo Machine Learning (Coveo ML)](https://docs.coveo.com/en/188/) for query suggestions (see [Omnibox - enableQuerySuggestAddon](https://coveo.github.io/search-ui/components/omnibox.html#options.enablequerysuggestaddon)).

Default value is `true`.

### `triggerQueryOnClear`

Specifies whether to trigger a query when the search box is cleared (see [Querybox - triggerQueryOnClear](https://coveo.github.io/search-ui/components/querybox.html#options.triggerqueryonclear)).

Default value is `true`.

### `enableQuerySyntax`

Specifies whether special characters should be interpreted as the Coveo query syntax (see [Querybox - enableQuerySyntax](https://coveo.github.io/search-ui/components/querybox.html#options.enablequerysyntax)).

Default value is `false`.

### `enableFieldAddon`

Specifies whether field names should be suggested (see [Omnibox - enableFieldAddon](https://coveo.github.io/search-ui/components/omnibox.html#options.enablefieldaddon)).

Default value is `false`.

### `enableQueryExtensionAddon`

Specifies whether to complete query extensions (see [Omnibox - enableQueryExtensionAddon](https://coveo.github.io/search-ui/components/omnibox.html#options.enablequeryextensionaddon)).

Default value is `false`.

### `customTokenGeneration`

Specifies whether to create a custom token instead of relying on the default one (see [Generating a custom search token for Coveo Lightning Aura components](https://docs.coveo.com/en/2745/)).

Default value is `false`.

### `debug`

Whether to load the non-minified versions of the different resources.

Setting this option to true enables more logging, but can be slower overall.
Only enable this when developing or debugging components.

Default value is `false`.