wp-calypso/packages/components/src/submenu-popover/README.md

SubmenuPopover (TSX)

Description

The SubmenuPopover component is used to render a popover menu with a submenu.

Table of contents

How to use

import '@wordpress/components/build-style/style.css';
import { DropdownMenu, Icon, MenuGroup, MenuItem } from '@wordpress/components';
import { chevronRight } from '@wordpress/icons';
import SubmenuPopover, { useSubmenuPopoverProps } from '.';

export const Menu = () => {
    const submenu = useSubmenuPopoverProps();
    const secondSubmenu = useSubmenuPopoverProps();
    return (
        <DropdownMenu label="Menu">
            { () => (
                <MenuGroup>
                    <MenuItem>Item 1</MenuItem>
                    <div { ...submenu.parent }>
                        <MenuItem>
                            Item 2 <Icon icon={ chevronRight } />
                        </MenuItem>
                        <SubmenuPopover { ...submenu.submenu }>
                            <MenuGroup>
                                <MenuItem>Item 2.1</MenuItem>
                                <MenuItem>Item 2.2</MenuItem>
                                <MenuItem>Item 2.4</MenuItem>
                            </MenuGroup>
                        </SubmenuPopover>
                    </div>
                    <MenuItem>Item 3</MenuItem>
                </MenuGroup>
            ) }
        </DropdownMenu>
    );
};

Props

The following props are available. Note that children is required. All the props needed are generated by the hook useSubmenuPopoverProps.

• children: (React.ReactNode) The content of the SubmenuPopover.
• isVisible: (boolean) if the submenu should be visible or not.
• ...rest: (object) Any other props to be passed to the @wordpress/components Popover.