useRelevantSort()

About this Hook

The useRelevantSort Hook isn’t currently available in React InstantSearch Hooks, but you can make it yourself using useConnector() along with connectRelevantSort.

Refer to the connectRelevantSort documentation for the full API reference.

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-hooks-web';
import connectRelevantSort from 'instantsearch.js/es/connectors/relevant-sort/connectRelevantSort';

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

export function RelevantSort(props) {
  const {
    isVirtualReplica,
    isRelevantSorted,
    canRefine,
    refine,
  } = useRelevantSort(props);

  return <>{/* Your JSX */}</>;
}

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-hooks-web';
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 {
    isVirtualReplica,
    isRelevantSorted,
    canRefine,
    refine,
  } = useRelevantSort(props);

  return <>{/* Your JSX */}</>;
}

Did you find this page helpful?

useRelevantSort()

About this Hook

Examples

On this page