Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Twilio-labs/paste/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Menu displays a list of actions or navigation options in a dropdown overlay. It’s triggered by a button and can contain interactive items, separators, groups, and nested submenus. Menus are ideal for presenting multiple related actions without cluttering the interface.

​
Installation

yarn add @twilio-paste/menu
Menu requires the Button component:
yarn add @twilio-paste/button

​
Usage

import {
  Menu,
  MenuButton,
  MenuItem,
  useMenuState,
} from '@twilio-paste/menu';
import { ChevronDownIcon } from '@twilio-paste/icons/esm/ChevronDownIcon';

const MyComponent = () => {
  const menu = useMenuState();
  
  return (
    <>
      <MenuButton {...menu} variant="primary">
        Actions <ChevronDownIcon decorative />
      </MenuButton>
      <Menu {...menu} aria-label="Actions">
        <MenuItem {...menu} onClick={() => console.log('edit')}>
          Edit
        </MenuItem>
        <MenuItem {...menu} onClick={() => console.log('duplicate')}>
          Duplicate
        </MenuItem>
        <MenuItem {...menu} onClick={() => console.log('delete')}>
          Delete
        </MenuItem>
      </Menu>
    </>
  );
};

​
Basic Menu

import {
  Menu,
  MenuButton,
  MenuItem,
  MenuSeparator,
  useMenuState,
} from '@twilio-paste/menu';
import { ChevronDownIcon } from '@twilio-paste/icons/esm/ChevronDownIcon';

const BasicMenu = () => {
  const menu = useMenuState();
  
  return (
    <>
      <MenuButton {...menu} variant="secondary">
        Options <ChevronDownIcon decorative />
      </MenuButton>
      <Menu {...menu} aria-label="Options">
        <MenuItem {...menu}>Settings</MenuItem>
        <MenuItem {...menu}>Preferences</MenuItem>
        <MenuSeparator {...menu} />
        <MenuItem {...menu}>Help</MenuItem>
      </Menu>
    </>
  );
};

​
Menu with Links

Menu items can be rendered as links for navigation. 
import {
  Menu,
  MenuButton,
  MenuItem,
  useMenuState,
} from '@twilio-paste/menu';
import { ChevronDownIcon } from '@twilio-paste/icons/esm/ChevronDownIcon';

const NavigationMenu = () => {
  const menu = useMenuState();
  
  return (
    <>
      <MenuButton {...menu} variant="secondary">
        Navigate <ChevronDownIcon decorative />
      </MenuButton>
      <Menu {...menu} aria-label="Navigation">
        <MenuItem {...menu} href="/dashboard">
          Dashboard
        </MenuItem>
        <MenuItem {...menu} href="/settings">
          Settings
        </MenuItem>
        <MenuItem {...menu} href="https://example.com">
          External link
        </MenuItem>
      </Menu>
    </>
  );
};

​
Destructive Menu Items

Use the destructive variant for items that perform irreversible actions. 
import {
  Menu,
  MenuButton,
  MenuItem,
  MenuSeparator,
  useMenuState,
} from '@twilio-paste/menu';
import { MoreIcon } from '@twilio-paste/icons/esm/MoreIcon';

const ActionsMenu = () => {
  const menu = useMenuState();
  
  return (
    <>
      <MenuButton {...menu} variant="secondary" size="icon">
        <MoreIcon decorative={false} title="More actions" />
      </MenuButton>
      <Menu {...menu} aria-label="Actions">
        <MenuItem {...menu}>Edit</MenuItem>
        <MenuItem {...menu}>Duplicate</MenuItem>
        <MenuSeparator {...menu} />
        <MenuItem {...menu} variant="destructive">
          Delete
        </MenuItem>
      </Menu>
    </>
  );
};

​
Menu Groups

Organize related menu items into labeled groups. 
import {
  Menu,
  MenuButton,
  MenuGroup,
  MenuItem,
  useMenuState,
} from '@twilio-paste/menu';
import { ChevronDownIcon } from '@twilio-paste/icons/esm/ChevronDownIcon';
import { ProductVoiceIcon } from '@twilio-paste/icons/esm/ProductVoiceIcon';

const GroupedMenu = () => {
  const menu = useMenuState();
  
  return (
    <>
      <MenuButton {...menu} variant="secondary">
        Products <ChevronDownIcon decorative />
      </MenuButton>
      <Menu {...menu} aria-label="Products">
        <MenuGroup {...menu} label="Voice" icon={<ProductVoiceIcon decorative />}>
          <MenuItem {...menu}>Programmable Voice</MenuItem>
          <MenuItem {...menu}>Voice Insights</MenuItem>
        </MenuGroup>
        <MenuGroup {...menu} label="Messaging">
          <MenuItem {...menu}>Programmable SMS</MenuItem>
          <MenuItem {...menu}>Conversations</MenuItem>
        </MenuGroup>
      </Menu>
    </>
  );
};

​
Checkable Menu Items

Use checkbox and radio items for selections. 
import {
  Menu,
  MenuButton,
  MenuItemCheckbox,
  MenuItemRadio,
  MenuSeparator,
  useMenuState,
} from '@twilio-paste/menu';
import { ChevronDownIcon } from '@twilio-paste/icons/esm/ChevronDownIcon';

const CheckableMenu = () => {
  const menu = useMenuState();
  const [notifications, setNotifications] = React.useState(true);
  const [view, setView] = React.useState('grid');
  
  return (
    <>
      <MenuButton {...menu} variant="secondary">
        View <ChevronDownIcon decorative />
      </MenuButton>
      <Menu {...menu} aria-label="View options">
        <MenuItemCheckbox
          {...menu}
          checked={notifications}
          onChange={(e) => setNotifications(e.target.checked)}
        >
          Show notifications
        </MenuItemCheckbox>
        <MenuSeparator {...menu} />
        <MenuItemRadio
          {...menu}
          name="view"
          value="grid"
          checked={view === 'grid'}
          onChange={(e) => setView(e.target.value)}
        >
          Grid view
        </MenuItemRadio>
        <MenuItemRadio
          {...menu}
          name="view"
          value="list"
          checked={view === 'list'}
          onChange={(e) => setView(e.target.value)}
        >
          List view
        </MenuItemRadio>
      </Menu>
    </>
  );
};

​
Submenu

Create nested menus for hierarchical navigation. 
import {
  Menu,
  MenuButton,
  MenuItem,
  SubMenuButton,
  useMenuState,
} from '@twilio-paste/menu';
import { ChevronDownIcon } from '@twilio-paste/icons/esm/ChevronDownIcon';

const PreferencesSubMenu = React.forwardRef((props, ref) => {
  const submenu = useMenuState();
  return (
    <>
      <SubMenuButton ref={ref} {...submenu} {...props}>
        Preferences
      </SubMenuButton>
      <Menu {...submenu} aria-label="Preferences">
        <MenuItem {...submenu}>Settings</MenuItem>
        <MenuItem {...submenu}>Extensions</MenuItem>
        <MenuItem {...submenu}>Keyboard shortcuts</MenuItem>
      </Menu>
    </>
  );
});

const MenuWithSubmenu = () => {
  const menu = useMenuState();
  
  return (
    <>
      <MenuButton {...menu} variant="secondary">
        Options <ChevronDownIcon decorative />
      </MenuButton>
      <Menu {...menu} aria-label="Options">
        <MenuItem {...menu}>Profile</MenuItem>
        <MenuItem {...menu} as={PreferencesSubMenu} />
        <MenuItem {...menu}>Help</MenuItem>
      </Menu>
    </>
  );
};

​
Props

​
Menu Props

PropTypeDefaultDescription
aria-labelstring-Accessible label for the menu (required)
elementstring'MENU'Customization element name
Menu also accepts props from the menu state returned by useMenuState.

​
MenuButton Props

PropTypeDefaultDescription
elementstring'MENU_BUTTON'Customization element name
MenuButton accepts all Button props and menu state props.

​
MenuItem Props

PropTypeDefaultDescription
hrefstring-Renders item as a link
variant'default' | 'destructive' | 'group_item''default'Visual variant of the item
disabledbooleanfalseDisables the menu item
elementstring'MENU_ITEM'Customization element name

​
MenuItemCheckbox Props

PropTypeDefaultDescription
checkedboolean-Checked state
onChangefunction-Change handler
elementstring'MENU_ITEM_CHECKBOX'Customization element name

​
MenuItemRadio Props

PropTypeDefaultDescription
namestring-Radio group name
valuestring-Radio value
checkedboolean-Checked state
onChangefunction-Change handler
elementstring'MENU_ITEM_RADIO'Customization element name

​
MenuGroup Props

PropTypeDefaultDescription
labelstring-Group label (required)
iconReactNode-Decorative icon
elementstring'MENU_GROUP'Customization element name

​
MenuSeparator Props

PropTypeDefaultDescription
elementstring'MENU_SEPARATOR'Customization element name

​
SubMenuButton Props

PropTypeDefaultDescription
elementstring'SUB_MENU_BUTTON'Customization element name

​
useMenuState Hook

Manages menu state including visibility and keyboard navigation. 
const menu = useMenuState({
  visible: false, // Initial visibility
  placement: 'bottom-start', // Menu placement
});
Returned State:
  • All state and methods needed for menu interaction
  • Spread onto Menu, MenuButton, and MenuItem components

​
Best Practices

​
Do

  • Use clear, action-oriented labels for menu items
  • Group related items together with MenuGroup or separators
  • Place destructive actions at the bottom, separated from other items
  • Provide an aria-label for the Menu component
  • Limit menu depth - avoid deeply nested submenus
  • Use icons in MenuButton to indicate the menu (ChevronDown, More)
  • Close the menu after an action is performed

​
Don’t

  • Don’t use menus for primary navigation (use navigation components instead)
  • Don’t put too many items in a single menu (consider submenus or alternative UI)
  • Don’t use menu items as links when you can use direct navigation
  • Don’t forget to handle menu item clicks
  • Don’t use menus when a select component would be more appropriate
  • Don’t nest menus more than 2 levels deep

​
Content Guidelines

  • Use sentence case for menu items
  • Keep labels concise (1-3 words)
  • Use verbs for actions (Edit, Delete, Share)
  • Use nouns for navigation (Settings, Profile, Help)
  • Be specific (“Delete message” vs. “Delete”)

​
Accessibility

  • Menu implements ARIA menu pattern with proper roles and states
  • Keyboard navigation: Arrow keys to navigate, Enter/Space to select, Escape to close
  • MenuButton sets aria-haspopup and aria-expanded appropriately
  • Menu automatically manages focus when opened and closed
  • Focus returns to MenuButton when menu closes
  • Disabled items are skipped in keyboard navigation
  • Checkable items announce their state to screen readers
  • Submenus open on hover, focus, or arrow key press

​
Keyboard Support

KeyAction
Enter / SpaceOpens menu (on button), activates item (in menu)
Arrow DownOpens menu (on button), moves focus to next item
Arrow UpOpens menu (on button), moves focus to previous item
Arrow RightOpens submenu
Arrow LeftCloses submenu
EscapeCloses menu
HomeMoves focus to first item
EndMoves focus to last item
TabCloses menu and moves focus to next focusable element

​
Related Components

  • Button - Trigger element for menus
  • Popover - For non-menu dropdown content
  • Select - For form selections

Build docs developers (and LLMs) love

Get started for freeTalk to us