---
title: Coveo Distance Sort
slug: '3063'
canonical_url: https://docs.coveo.com/en/3063/
collection: coveo-for-sitecore-v5
source_format: adoc
---
# Coveo Distance Sort
> **Legacy feature**
>
> The Coveo Hive Framework is now in maintenance mode and is no longer recommended for new implementations.
> 
> To build new search experiences, use one of Coveo's more modern, lightweight, and responsive libraries.
> To get started, see the [Build search](https://docs.coveo.com/en/2473/) article.

Implements the [Coveo JavaScript Search Framework](https://docs.coveo.com/en/187/) [Sort](https://coveo.github.io/search-ui/components/sort.html) component with the `sortCriteria` component option set to `@<DISTANCE_SORT_FIELD> ascending`.
Clicking the **Coveo Distance Sort** search interface control allows the user to switch to search result sorting based on distance, with items nearest to the user appearing first.

## Usage notes

* To use the **Coveo Distance Sort** rendering, you first need to add the [Coveo Distance Resources](https://docs.coveo.com/en/2272/) rendering and a [Position Providers](https://docs.coveo.com/en/2999/) rendering to automatically calculate the user-item distance and store it in the `Distance sort field`.

* When a user changes the search results sorting option by clicking another Coveo Sort search interface control, this triggers a Search API call with the requested `sortCriteria` in the query parameters.

* You can [customize the CSS](https://docs.coveo.com/en/2342/) associated with this rendering.

## Insertion location


<div>
<h3>Coveo Hive</h3>
  <p>The <strong>Coveo Distance Sort</strong> rendering is an Allowed Control in the following placeholder(s): <code class="highlighter-rouge">Sorts</code></p>
  <video width="690" height="335" controls="">
  <source src="{{ site.baseurl }}/assets/images/c4sc-v5/distance-sort-hive.mp4" type="video/mp4" />
  Your browser doesn't support the video tag.
</video>
  <div class="figure-caption">Example insertion sequence for the <strong>Coveo Distance Sort</strong> rendering.
  </div>
</div>
<div>
<h3>Coveo Hive SXA</h3>
  <p>Coveo for Sitecore SXA rendering insertion locations aren't limited by placeholder Allowed Controls. The <strong>Coveo Distance Sort</strong> rendering may therefore be inserted throughout the partial design, whether in Coveo for Sitecore or Sitecore placeholders.</p>
  <video width="690" height="335" controls="">
  <source src="{{ site.baseurl }}/assets/images/c4sc-v5/distance-sort-sxa.mp4" type="video/mp4" />
  Your browser doesn't support the video tag.
</video>
  <div class="figure-caption">Example insertion sequence for the <strong>Coveo Distance Sort</strong> rendering.
  </div>
</div>

## Data source options

The following table lists the available data source options for this rendering.

[%header,cols="33%,66%"]
|===
|Option name
|Description

|Caption
|See the [caption](https://coveo.github.io/search-ui/components/sort.html#options.caption) component option.

|Distance sort field
|See the [sortCriteria](https://coveo.github.io/search-ui/components/sort.html#options.sortcriteria) component option.

|DOM unique ID
a|{empty}
--
Randomly generated HTML element ID.
--

|Additional data attributes
a|{empty}
--
Allows [use of the Coveo JavaScript Search Framework **Sort** component options](https://docs.coveo.com/en/2776/) that aren't directly available in the data source.
--
|===

## Sample generated HTML and corresponding visual output

```html
<div class="coveo-sort-container">
   <span id="coveoef34db1e"
   class="CoveoSort coveo-accessible-button coveo-accessible-button-pressed coveo-selected"
   data-caption="Store Distance" data-prebind-sort-criteria="sortCriteriaResolver"
   data-sort-criteria="@delta ascending" data-sc-enable-both-sort-directions="false"
   data-applied-prebind="true" role="button" aria-label="Sort results by Store Distance"
   tabindex="0">
      Store Distance
   </span>
   <span class="coveo-distance-disabled-tooltip">
      Disabled. Please configure the distance resources component.
   </span>
</div>
```

![Distance Sort example | Coveo for Sitecore 5](https://docs.coveo.com/en/assets/images/c4sc-v5/distance-sort-example.gif)