useRatingMenu()

About this Hook

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

Refer to the connectRatingMenu 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
18
19
import { useConnector } from 'react-instantsearch-hooks-web';
import connectRatingMenu from 'instantsearch.js/es/connectors/rating-menu/connectRatingMenu';

export function useRatingMenu(props) {
  return useConnector(connectRatingMenu, props);
}

export function RatingMenu(props) {
  const {
    items,
    hasNoResults,
    canRefine,
    refine,
    sendEvent,
    createURL,
  } = useRatingMenu(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
28
29
import { useConnector } from 'react-instantsearch-hooks-web';
import connectRatingMenu from 'instantsearch.js/es/connectors/rating-menu/connectRatingMenu';

import type {
  RatingMenuConnectorParams,
  RatingMenuWidgetDescription,
} from 'instantsearch.js/es/connectors/rating-menu/connectRatingMenu';

export type UseRatingMenuProps = RatingMenuConnectorParams;

export function useRatingMenu(props?: UseRatingMenuProps) {
  return useConnector<RatingMenuConnectorParams, RatingMenuWidgetDescription>(
    connectRatingMenu,
    props
  );
}

export function RatingMenu(props: UseRatingMenuProps) {
  const {
    items,
    hasNoResults,
    canRefine,
    refine,
    sendEvent,
    createURL,
  } = useRatingMenu(props);

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

Did you find this page helpful?

useRatingMenu()

About this Hook

Examples

On this page