Coveo Share Query

Share Query Menu Option

Implements the Coveo JavaScript Search Framework ShareQuery component which populates the Settings popup menu with a Share Query menu item.

Selecting the Share Query menu item allows a user to share the URL of the current search interface and the current complete query, which another user may paste directly in their searchbox.

Usage Notes

  • In the Share Query modal, the value in the Complete query field represents the combined query expression (((q AND aq) OR dq) AND cq). When this combined query expression is pasted into a search box, it becomes the basic query expression (q) of the new search query (see About the Query Expression).

  • For combined query expressions pasted in a search box to be interpreted correctly, the Enable query syntax option in the search box data source must be set to Enabled.

Insertion Location

The Coveo Share Query rendering is an Allowed Control in the following placeholder(s): Searchbox Options

Example insertion sequence for the Coveo Share Query rendering.

Coveo for Sitecore SXA rendering insertion locations aren’t limited by placeholder Allowed Controls. The Coveo Share Query rendering may therefore be inserted throughout the partial design, whether in Coveo for Sitecore or Sitecore placeholders.

To ease rendering management, group Coveo Advanced Search, Coveo Export To Excel, Coveo Preferences Panel and Coveo Share Query renderings together near your Coveo Settings Button rendering.

Example insertion sequence for the Coveo Share Query rendering.

Data Source Options

This rendering has no data source.

Sample Generated HTML and Corresponding Visual Output

Generated HTML:

<div class="CoveoShareQuery">
</div>

User search:

A website visitor performs a query using the terms west lake in the search box.

Search on west lake

Displayed Share Query modal:

The visitor then selects the Share Query option in the Settings popup menu.

Share Query Modal

What's Next for Me?