useRelevantSort()

This is the React InstantSearch v7 documentation. React InstantSearch v7 is the latest version of React InstantSearch and the stable version of React InstantSearch Hooks.

If you were using React InstantSearch v6, you can upgrade to v7.

If you were using React InstantSearch Hooks, you can still use the React InstantSearch v7 documentation, but you should check the upgrade guide for necessary changes.

If you want to keep using React InstantSearch v6, you can find the archived documentation.

About this Hook

This Hook allows switching between relevant and exhaustive sorting when searching in virtual replica indices.

The useRelevantSort Hook isn’t available in React InstantSearch, but you can make a custom version with useConnector() and connectRelevantSort.

See code examples

Examples

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import { useConnector } from 'react-instantsearch';
import connectRelevantSort from 'instantsearch.js/es/connectors/relevant-sort/connectRelevantSort';

export function useRelevantSort(props) {
  return useConnector(connectRelevantSort, props);
}

export function RelevantSort(props) {
  const { isRelevantSorted, refine } = useRelevantSort(props);
  const relevancyStrictness = isRelevantSorted ? 0 : undefined;

  return (
    <button type="button" onClick={() => refine(relevancyStrictness)}>
      {isRelevantSorted ? 'See all results' : 'See relevant results'}
    </button>
  );
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
import { useConnector } from 'react-instantsearch';
import connectRelevantSort from 'instantsearch.js/es/connectors/relevant-sort/connectRelevantSort';

import type {
  RelevantSortConnectorParams,
  RelevantSortWidgetDescription,
} from 'instantsearch.js/es/connectors/relevant-sort/connectRelevantSort';

export type UseRelevantSortProps = RelevantSortConnectorParams;

export function useRelevantSort(props?: UseRelevantSortProps) {
  return useConnector<RelevantSortConnectorParams, RelevantSortWidgetDescription>(
    connectRelevantSort,
    props
  );
}

export function RelevantSort(props: UseRelevantSortProps) {
  const { isRelevantSorted, refine } = useRelevantSort(props);
  const relevancyStrictness = isRelevantSorted ? 0 : undefined;

  return (
    <button type="button" onClick={() => refine(relevancyStrictness)}>
      {isRelevantSorted ? 'See all results' : 'See relevant results'}
    </button>
  );
}

Did you find this page helpful?

useRelevantSort()

About this Hook

Examples

On this page