MenuItem Edit

MenuItem is a component which renders a button intended to be used in combination with the DropdownMenu component.

Usage Usage

import { MenuItem } from '@wordpress/components';
import { withState } from '@wordpress/compose';

const MyMenuItem = withState( {
    isActive: true,
} )( ( { isActive, setState } ) => (
    <MenuItem
        icon={ isActive ? 'yes' : 'no' }
        isSelected={ isActive }
        onClick={ () => setState( state => ( { isActive: ! state.isActive } ) ) }
    >
        Toggle
    </MenuItem>
) );

Top ↑

Props Props

MenuItem supports the following props. Any additional props are passed through to the underlying Button or IconButton component.

children children

  • Type: WPElement
  • Required: No

Element to render as child of button.

Top ↑

info info

  • Type: string
  • Required: No

Text to use as description for button text.

Refer to documentation for label.

Top ↑

icon icon

  • Type: string
  • Required: No

Refer to documentation for IconButton’s icon prop.

Top ↑

isSelected isSelected

  • Type: boolean
  • Required: No

Whether or not the menu item is currently selected.

Top ↑

shortcut shortcut

  • Type: string
  • Required: No

Refer to documentation for Shortcut’s shortcut prop.

Top ↑

role role

  • Type: string
  • Require: No
  • Default: 'menuitem'

Aria Spec. If you need to have selectable menu items use menuitemradio for single select, and menuitemcheckbox for multiselect.