> ## Documentation Index
> Fetch the complete documentation index at: https://algolia.com/llms.txt
> Use this file to discover all available pages before exploring further.

# useNumericMenu

> React Hook for refining search results by numeric filters.

export const Records = () => <Tooltip tip="A record is a searchable object in an Algolia index. Each record consists of named attributes." cta="Algolia records" href="/doc/guides/sending-and-managing-data/prepare-your-data#algolia-records">
    records
  </Tooltip>;

<Note>
  This is the **React InstantSearch v7** documentation.
  If you're upgrading from v6, see the [upgrade guide](/doc/guides/building-search-ui/upgrade-guides/react/#migrate-from-react-instantsearch-v6-to-react-instantsearch-v7).
  If you were using React InstantSearch Hooks,
  this v7 documentation applies—just check for [necessary changes](/doc/guides/building-search-ui/upgrade-guides/react/#migrate-from-react-instantsearch-hooks-to-react-instantsearch-v7).
  To continue using v6, you can find the [archived documentation](https://algolia.com/old-docs/deprecated/instantsearch/react/v6/api-reference/instantsearch/).
</Note>

```tsx Signature theme={"system"}
  const numericMenuApi = useNumericMenu({
    attribute: string,
    items: object[],
    // Optional parameters
    transformItems: function,
  }
```

## Import

```jsx JavaScript icon=code theme={"system"}
import { useNumericMenu } from "react-instantsearch";
```

<Card title="See this widget in action" icon="monitor-play" href="https://instantsearchjs.netlify.app/stories/js/?path=/story/refinements-numericMenu--default" horizontal>
  Preview this widget and its behavior.
</Card>

## About this Hook

React Hook for a list of numeric filters that are pre-configured when creating the widget.

Numeric menus let users choose a single value for a specific attribute.

### Requirements

The attribute provided to the hook is already declared as an [attribute for faceting](/doc/guides/managing-results/refine-results/faceting/how-to/declaring-attributes-for-faceting).

All values must be numbers, not strings.

## Examples

<CodeGroup>
  ```tsx JavaScript theme={"system"}
  import React from 'react';
  import { useNumericMenu } from 'react-instantsearch';

  function NumericMenu(props) {
    const { items, refine } = useNumericMenu(props);

    return (
      <ul>
        {items.map((item) => (
          <li key={item.value}>
            <label>
              <input
                type="radio"
                name={item.attribute}
                defaultChecked={item.isRefined}
                onChange={(event) => {
                  event.preventDefault();

                  refine(item.value);
                }}
              />
              <span>{item.label}</span>
            </label>
          </li>
        ))}
      </ul>
    );
  }
  ```

  ```tsx TypeScript icon=code theme={"system"}
  import React from "react";
  import { useNumericMenu, UseNumericMenuProps } from "react-instantsearch";

  function NumericMenu(props: UseNumericMenuProps) {
    const { items, refine } = useNumericMenu(props);

    return (
      <ul>
        {items.map((item) => (
          <li key={item.value}>
            <label>
              <input
                type="radio"
                name={item.attribute}
                defaultChecked={item.isRefined}
                onChange={(event) => {
                  event.preventDefault();

                  refine(item.value);
                }}
              />
              <span>{item.label}</span>
            </label>
          </li>
        ))}
      </ul>
    );
  }
  ```
</CodeGroup>

You can check the [`<NumericMenu>` example](https://github.com/algolia/instantsearch/blob/master/examples/react/default-theme/src/components/NumericMenu.tsx) for full markup.

## Parameters

<ParamField body="attribute" type="string" required>
  The name of the attribute in the <Records />.

  ```jsx JavaScript icon=code theme={"system"}
  const numericMenuApi = useNumericMenu({
    // ...
    attribute: "categories",
  });
  ```
</ParamField>

<ParamField body="items" type="object[]" required>
  A list of all the options to display, with:

  * `label: string`. Label of the option.
  * `start: number`. The option must be greater than or equal to `start` (lower bound).
  * `end: number`. The option must be smaller than or equal to `end` (upper bound).

  ```jsx JavaScript icon=code theme={"system"}
  const numericMenuApi = useNumericMenu({
    // ...
    items: [
      { label: "All" },
      { label: "Less than 500$", end: 500 },
      { label: "Between 500$ - 1000$", start: 500, end: 1000 },
      { label: "More than 1000$", start: 1000 },
    ],
  });
  ```
</ParamField>

<ParamField body="transformItems" type="(items: object[], metadata: { results: SearchResults }) => object[]">
  A function that receives the list of items before they are displayed.
  It should return a new array with the same structure.
  Use this to transform, filter, or reorder the items.

  The function also has access to the full `results` data,
  including all standard [response parameters](/doc/guides/building-search-ui/going-further/backend-search/in-depth/understanding-the-api-response/)
  and [parameters from the helper](https://community.algolia.com/algoliasearch-helper-js/reference.html#query-parameters),
  such as `disjunctiveFacetsRefinements`.

  ```jsx JavaScript icon=code theme={"system"}
  const numericMenuApi = useNumericMenu({
    // ...
    transformItems(items) {
      return items.map((item) => ({
        ...item,
        label: item.label.toUpperCase(),
      }));
    },

    // or, combined with results
    transformItems(items, { results }) {
      return items.map((item) => ({
        ...item,
        label:
          item.isRefined && results
            ? `${item.label} (${results.nbHits} hits)`
            : item.label,
      }));
    },
  });
  ```
</ParamField>

## Returns

<ParamField body="items" type="NumericMenuItem[]">
  The list of available options, with each option:

  * `label: string`. The label for the option.
  * `value: string`. The encoded URL of the bounds object with the `{start, end}` form. This value can be used verbatim in the web page and can be read by `refine` directly. If you want to inspect the value, you can do `JSON.parse(window.decodeURI(value))` to get the object.
  * `isRefined: boolean`. Whether the refinement is selected.

  ```ts TypeScript icon=code theme={"system"}
  type NumericMenuItem = {
    value: string;
    label: string;
    isRefined: boolean;
  };
  ```
</ParamField>

<ParamField body="canRefine" type="boolean">
  Whether the search can be refined.
</ParamField>

<ParamField body="createURL" type="(value: string) => string">
  Creates the next state URL of a selected refinement.
</ParamField>

<ParamField body="refine" type="(value: string) => string">
  Applies the selected refinement.
</ParamField>

<ParamField body="sendEvent" type="(eventType: string, facetValue: string, eventName?: string) => void">
  Sends an event to the Insights middleware.
</ParamField>