ExposedDropdownMenuBox

A Jetpack Compose ExposedDropdownMenuBox component for displaying a dropdown menu with a customizable anchor.

Android

Included in Expo Go

GitHub

npm

Changelog

Recommended version:

~57.0.15

For a cross-platform picker, see Picker — built on top of ExposedDropdownMenuBox on Android.

Expo UI ExposedDropdownMenuBox matches the official Jetpack Compose ExposedDropdownMenuBox. Use the menuAnchor() modifier on the anchor content (typically a read-only TextField) and ExposedDropdownMenu to wrap DropdownMenuItem children.

Exposed dropdown menu showing four language options anchored to a text field

Installation

Terminal

- npx expo install @expo/ui

- yarn expo install @expo/ui

- pnpm expo install @expo/ui

- bun expo install @expo/ui

If you are installing this in an existing React Native app, make sure to install expo in your project.

Usage

Basic

The anchor is a read-only TextField bound to a useNativeState observable. Update that observable in each item's onClick to reflect the selected value.

BasicExposedDropdownMenuBoxExample.tsx

import {
  DropdownMenuItem,
  ExposedDropdownMenuBox,
  ExposedDropdownMenu,
  Host,
  Text,
  TextField,
  useNativeState,
} from '@expo/ui/jetpack-compose';
import { menuAnchor } from '@expo/ui/jetpack-compose/modifiers';
import { useState } from 'react';

const LANGUAGES = [
  { label: 'Java', value: 'java' },
  { label: 'JavaScript', value: 'js' },
  { label: 'TypeScript', value: 'ts' },
];

export default function BasicExposedDropdownMenuBoxExample() {
  const selectedLabel = useNativeState('Java');
  const [expanded, setExpanded] = useState(false);

  return (
    <Host matchContents>
      <ExposedDropdownMenuBox
        expanded={expanded}
        onExpandedChange={setExpanded}>
        <TextField
          value={selectedLabel}
          readOnly
          modifiers={[menuAnchor()]}
        />
        <ExposedDropdownMenu
          expanded={expanded}
          onDismissRequest={() => setExpanded(false)}>
          {LANGUAGES.map(lang => (
            <DropdownMenuItem
              key={lang.value}
              onClick={() => {
                selectedLabel.value = lang.label;
                setExpanded(false);
              }}>
              <DropdownMenuItem.Text>
                <Text>{lang.label}</Text>
              </DropdownMenuItem.Text>
            </DropdownMenuItem>
          ))}
        </ExposedDropdownMenu>
      </ExposedDropdownMenuBox>
    </Host>
  );
}

API

import { ExposedDropdownMenuBox } from '@expo/ui/jetpack-compose';

Components

`ExposedDropdownMenu`

Android

Type: React.Element<ExposedDropdownMenuProps>

A Material 3 ExposedDropdownMenu that displays menu items in a dropdown.

Must be used inside an ExposedDropdownMenuBox.

Props for the ExposedDropdownMenu component.

ExposedDropdownMenuProps

`children`

Android

Optional • Type: ReactNode

Children should be DropdownMenuItem components.

`containerColor`

Android

Optional • Type: ColorValue

Background color of the dropdown menu container.

`expanded`

Android

Type: boolean

Whether the dropdown menu is expanded (visible).

`modifiers`

Android

Optional • Type: ModifierConfig[]

Modifiers for the component.

`onDismissRequest`

Android

Optional • Type: () => void

Callback fired when the menu requests to be dismissed (e.g. tapping outside, back button).

`ExposedDropdownMenuBox`

Android

Type: React.Element<ExposedDropdownMenuBoxProps>

A Material 3 ExposedDropdownMenuBox.

Use the menuAnchor() modifier on the anchor content (e.g. a TextField or Text). Use ExposedDropdownMenu to wrap DropdownMenuItem children.

Example

<ExposedDropdownMenuBox expanded={expanded} onExpandedChange={setExpanded}>
  <TextField modifiers={[menuAnchor()]} defaultValue={value} readOnly />
  <ExposedDropdownMenu expanded={expanded} onDismissRequest={() => setExpanded(false)}>
    <DropdownMenuItem onClick={() => { setSelected('a'); setExpanded(false); }}>
      <DropdownMenuItem.Text><Text>Option A</Text></DropdownMenuItem.Text>
    </DropdownMenuItem>
  </ExposedDropdownMenu>
</ExposedDropdownMenuBox>

ExposedDropdownMenuBoxProps

`children`

Android

Optional • Type: ReactNode

Children — should contain an anchor element with the menuAnchor() modifier and an ExposedDropdownMenu with DropdownMenuItem children.

`expanded`

Android

Type: boolean

Whether the dropdown menu is expanded (visible).

`modifiers`

Android

Optional • Type: ModifierConfig[]

Modifiers for the component.

`onExpandedChange`

Android

Optional • Type: (expanded: boolean) => void

Callback when the expanded state changes (for example, tapping the field or dismissing the menu).