---
title: CommunitySearchBox Lightning Component
slug: '2946'
canonical_url: https://docs.coveo.com/en/2946/
collection: coveo-for-salesforce
source_format: adoc
---
# CommunitySearchBox Lightning Component
The `CommunitySearchBox` Lightning component lets you 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.

## 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:CommunitySearchBox/>
</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) library, and the Coveo for Salesforce specific assets.

> **Note**
>
> Since Lightning Locker is automatically enabled on this component, the [underscore result templates](https://docs.coveo.com/en/413#using-the-underscore-engine) aren't supported. Use [HTML templates](https://docs.coveo.com/en/413#using-the-html-engine-recommended) instead.

## Aura Event

This component doesn't offer any Aura events.

## Options

The component offers the following options:

### name

The name of the Coveo Search component you want to associate to your search box.

Default value is `communitySearchCoveo`.

> **Note**
>
> It's good practice to use the same `name` value as your [Community Search](https://docs.coveo.com/en/2945/) component.

### searchHub

The name of the [search hub](https://docs.coveo.com/en/1342/) used for [Coveo Analytics](https://docs.coveo.com/en/182/) reports.

Default value is the same value as `name`.

> **Note**
>
> It's good practice to use the same `searchHub` value as your [Community Search](https://docs.coveo.com/en/2945/) component.

### placeholder

The placeholder text to put in the search box when no query is entered.

Default value is empty.

### triggerQueryOnClear

Specifies whether to trigger a query when the search box is cleared.

Default value is `true`.

### enableQuerySyntax

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

Default value is `false`.

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

### searchPageName

The page where your search box should redirect.

Depending on your Salesforce version, the value should either be:

**Before Winter '18**: `search/all/home/%40uri`

**Winter '18 and up**: `global-search/%40uri`

### debug

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

Default value is `false`.

### facetValueSuggestFields

Provides end users with scoped [query suggestions](https://docs.coveo.com/en/1015/) based on the values of a specific facet-enabled field (see [Facet Value Suggestion Fields](https://docs.coveo.com/en/1500#facet-value-suggestion-fields)).

Default value is `empty`.