API Reference / React InstantSearch Hooks / <Menu>

Sep. 12, 2022

<Menu>

Signature

<Menu
  attribute={string}
  // Optional parameters
  limit={number}
  showMore={boolean}
  showMoreLimit={number}
  sortBy={string[] | function}
  transformItems={function}
  classNames={object}
  ...props={ComponentProps<'div'>}
/>

Import

Copy

1
import { Menu } from 'react-instantsearch-hooks-web';

See code examples

See live example

About this widget

<Menu> is a widget that displays a list of facets and lets users choose a single value.

Requirements

Ensure that the attribute provided to the hook is already declared as an attribute for faceting.

You can also create your own UI with useMenu().

Examples

Copy
import React from 'react';
import algoliasearch from 'algoliasearch/lite';
import { InstantSearch, Menu } from 'react-instantsearch-hooks-web';

const searchClient = algoliasearch('YourApplicationID', 'YourSearchOnlyAPIKey');

function App() {
  return (
    <InstantSearch indexName="instant_search" searchClient={searchClient}>
      <Menu attribute="categories" />
    </InstantSearch>
  );
}

Props


            attribute

type: string

Required

The name of the attribute in the records.

Copy
<Menu attribute="categories" />


            limit

type: number

default: 10

How many facet values to retrieve.

showMore and showMoreLimit determine the number of facet values to display before clicking the Show more button.

Copy
<Menu
  // ...
  limit={15}
/>


            showMore

type: boolean

default: false

Whether to display a button that expands the number of items.

Copy
<Menu
  // ...
  showMore={true}
/>


            showMoreLimit

type: number

The maximum number of items to display if the widget is showing more than the limit items.

Copy
<Menu
  // ...
  showMoreLimit={25}
/>


            sortBy

type: string[] | (a: FacetValue, b: FacetValue) => number

default: ["isRefined", "name:asc"], or `facetOrdering` if set

How to sort refinements. Must be one or more of the following strings:

"count" (same as "count:desc")
"count:asc"
"count:desc"
"name" (same as "name:asc")
"name:asc"
"name:desc"
"isRefined" (same as "isRefined:asc")
"isRefined:asc"
"isRefined:desc"

You can also use a sort function that behaves like the standard Javascript compareFunction.

If you leave the default setting for this parameter, and you’ve set facetOrdering for this facet in renderingContent, facets are sorted using facetOrdering and use the default order as a fallback.

Copy

1
2
3
4
<Menu
  // ...
  sortBy={['count:desc', 'name:asc']}
/>

1
2
3
4
5
6
7
8
9
10
11
12
const sortByName = (a, b) => {
  return a.name.toLocaleLowerCase() < b.name.toLocaleLowerCase() ? -1 : 1;
};

function Search() {
  return (
    <Menu
      // ...
      sortBy={sortByName}
    />
  );
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
import type { MenuProps } from 'react-instantsearch-hooks-web';

const sortByName: MenuProps['sortBy'] = (a, b) => {
  return a.name.toLocaleLowerCase() < b.name.toLocaleLowerCase() ? -1 : 1;
};

function Search() {
  return (
    <Menu
      // ...
      sortBy={sortByName}
    />
  );
}


            transformItems

type: (items: object[], metadata: { results: SearchResults }) => object[]

Receives the items and is called before displaying them. Should return a new array with the same shape as the original array. Useful for transforming, removing, or reordering items.

In addition, the full results data is available, which includes all regular response parameters, as well as parameters from the helper (for example disjunctiveFacetsRefinements).

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
const transformItems = (items) => {
  return items.map((item) => ({
    ...item,
    label: item.label.toUpperCase(),
  }));
};

function Search() {
  return (
    <Menu
      // ...
      transformItems={transformItems}
    />
  );
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import type { MenuProps } from 'react-instantsearch-hooks-web';

const transformItems: MenuProps['transformItems'] = (items) => {
  return items.map((item) => ({
    ...item,
    label: item.label.toUpperCase(),
  }));
};

function Search() {
  return (
    <Menu
      // ...
      transformItems={transformItems}
    />
  );
}


            classNames

type: Partial<MenuClassNames>

Optional

CSS classes to pass to the widget’s elements. This is useful to style widgets with class-based CSS frameworks like Bootstrap or Tailwind CSS.

root: The root element of the widget.
noRefinementRoot: The root element when there are no refinements.
list: The list element.
item: Each item element..
selectedItem: The selected item element.
link: The link of each item.
label: The label of each item.
count: The count of each item.
showMore: The “Show more” button.
disabledShowMore: The disabled “Show more” button.

Copy
<Menu
  // ...
  classNames={{
    root: 'MyCustomMenu',
    list: 'MyCustomMenuList MyCustomMenuList--subclass',
  }}
/>


            ...props

type: React.ComponentProps<'div'>

Optional

Any <div> prop to forward to the root element of the widget.

Copy
<Menu
  // ...
  className="MyCustomMenu" title="My custom title"
/>

Hook

React InstantSearch Hooks let you create your own UI for the <Menu> widget with useMenu(). Hooks provide APIs to access the widget state and interact with InstantSearch.

The useMenu() Hook accepts parameters and returns APIs.

See code examples

Usage

First, create your React component:

import { useMenu } from 'react-instantsearch-hooks-web';

function CustomMenu(props) {
  const { 
    items,
    createURL,
    refine,
    canRefine,
    isShowingMore,
    toggleShowMore,
    canToggleShowMore,
    sendEvent,
   } = useMenu(props);

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

Then, render the widget:

<CustomMenu {...props} />

Parameters

Hooks accept parameters. You can pass them manually, or forward the props from your custom component.

When you provide a function to Hooks, make sure to pass a stable reference to avoid rendering endlessly (for example, with useCallback()). Objects and arrays are memoized; you don’t need to stabilize them.


            attribute

type: string

Required

The name of the attribute in the records.

Copy
const menuApi = useMenu({
  attribute: 'categories',
});


            limit

type: number

default: 10

How many facet values to retrieve.

showMore and showMoreLimit determine the number of facet values to display before clicking the Show more button.

Copy
const menuApi = useMenu({
  // ...
  limit: 5,
});


            showMore

type: boolean

default: false

Whether to display a button that expands the number of items.

Copy
const menuApi = useMenu({
  // ...
  showMore: true,
});


            showMoreLimit

type: number

The maximum number of items to display if the widget is showing more than the limit items.

Copy
const menuApi = useMenu({
  // ...
  showMoreLimit: 20,
});


            sortBy

type: string[] | (a: FacetValue, b: FacetValue) => number

default: ["isRefined", "name:asc"], or `facetOrdering` if set

How to sort refinements. Must be one or more of the following strings:

"count" (same as "count:desc")
"count:asc"
"count:desc"
"name" (same as "name:asc")
"name:asc"
"name:desc"
"isRefined" (same as "isRefined:asc")
"isRefined:asc"
"isRefined:desc"

You can also use a sort function that behaves like the standard Javascript compareFunction.

Copy

1
2
3
4
const menuApi = useMenu({
  // ...
  sortBy: ['count:desc', 'name:asc'],
});

1
2
3
4
5
6
7
8
9
10
11
12
const sortByName = (a, b) => {
  return a.name.toLocaleLowerCase() < b.name.toLocaleLowerCase() ? -1 : 1;
};

function Menu() {
  const menuApi = useMenu({
    // ...
    sortBy,
  });

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
import type { UseMenuProps } from 'react-instantsearch-hooks-web';

const sortByName: UseMenuProps['sortBy'] = (a, b) => {
  return a.name.toLocaleLowerCase() < b.name.toLocaleLowerCase() ? -1 : 1;
};

function Menu() {
  const menuApi = useMenu({
    // ...
    sortBy,
  });

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


            transformItems

type: (items: object[], metadata: { results: SearchResults }) => object[]

Receives the items and is called before displaying them. Should return a new array with the same shape as the original array. Useful for transforming, removing, or reordering items.

In addition, the full results data is available, which includes all regular response parameters, as well as parameters from the helper (for example disjunctiveFacetsRefinements).

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
const transformItems = (items) => {
  return items.map((item) => ({
    ...item,
    label: item.label.toUpperCase(),
  }));
};

function Menu() {
  const menuApi = useMenu({
    // ...
    transformItems,
  });

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import type { UseMenuProps } from 'react-instantsearch-hooks-web';

const transformItems: UseMenuProps['transformItems'] = (items) => {
  return items.map((item) => ({
    ...item,
    label: item.label.toUpperCase(),
  }));
};

function Menu() {
  const menuApi = useMenu({
    // ...
    transformItems,
  });

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

APIs

Hooks return APIs, such as state and functions. You can use them to build your UI and interact with React InstantSearch.


            items

type: MenuItem[]

The elements that can be refined for the current search results.

Copy
type MenuItem = {
  /**
   * The value of the menu item.
   */
  value: string;
  /**
   * Human-readable value of the menu item.
   */
  label: string;
  /**
   * Number of matched results after refinement is applied.
   */
  count: number;
  /**
   * Indicates if the menu item is refined.
   */
  isRefined: boolean;
};


            createURL

type: (value: string) => string

Creates the next state URL of a selected refinement.


            refine

type: (value: string) => string

Applies the selected refinement.


            canRefine

type: boolean

Whether a refinement can be applied.


            isShowingMore

type: boolean

Whether the menu is displaying all the menu items.


            toggleShowMore

type: () => void

Toggles the number of values displayed between limit and showMoreLimit.


            canToggleShowMore

type: boolean

Whether the Show more button can be activated, meaning there are enough additional items to display, or already displaying over the limit items.


            sendEvent

type: (eventType: string, facetValue: string, eventName?: string) => void

Sends an event to the Insights middleware.

Example

Copy

1
2
3
4
5
6
7
8
import React from 'react';
import { useMenu } from 'react-instantsearch-hooks-web';

function CustomMenu(props) {
  const { items, refine } = useMenu(props);

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

1
2
3
4
5
6
7
8
import React from 'react';
import { useMenu, UseMenuProps } from 'react-instantsearch-hooks-web';

function CustomMenu(props: UseMenuProps) {
  const { items, refine } = useMenu(props);

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

Did you find this page helpful?

<Menu>

About this widget

Requirements

Examples

Props

Hook

Usage

Parameters

APIs

Example

On this page