MenuItem

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

Usage

import { useState } from 'react';
import { MenuItem } from '@wordpress/components';

const MyMenuItem = () => {
    const [ isActive, setIsActive ] = useState( true );

    return (
        <MenuItem
            icon={ isActive ? 'yes' : 'no' }
            isSelected={ isActive }
            onClick={ () => setIsActive( ( state ) => ! state ) }
        >
            Toggle
        </MenuItem>
    );
};

Props

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

children

• Type: Element
• Required: No

Element to render as child of button.

disabled

• Type: boolean
• Required: No

Refer to documentation for Button’s disabled prop.

info

• Type: string
• Required: No

Text to use as description for button text.

Refer to documentation for label.

icon

• Type: string
• Required: No

Refer to documentation for Button’s icon prop.

iconPosition

• Type: string
• Required: No
• Default: 'right'

Determines where to display the provided icon.

isSelected

• Type: boolean
• Required: No

Whether or not the menu item is currently selected. isSelected is only taken into account when the role prop is either "menuitemcheckbox" or "menuitemradio".

shortcut

• Type: string or object
• Required: No

If shortcut is a string, it is expecting the display text. If shortcut is an object, it will accept the properties of display (string) and ariaLabel (string).

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.

suffix

• Type: Element
• Required: No

Allows for markup other than icons or shortcuts to be added to the menu item.