import * as React from 'react';
import type { MenuItemProps } from '../MenuItem';
import type { MenuPopoverProps } from './MenuPopover';
import type { MenuProps, MenuRef } from '../Menu';
import type { BDSForwardRef } from '../utils/typings/BDSComponentProps';
/**
* Backyard React Sub Menu
*
* `SubMenu` extends both `Menu` and `MenuPopover` to provide a simple way to make a
* functional deep menu for a user to navigate.
*
* `SubMenu` will use `disableClick` and `listenHover` from the outer most `MenuPopover` ancestor.
*
* Example:
* ```
*
*
* }
* >
* Home
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
* }
* >
* Download
*
*
*
* )}
* >
*
*
*
*
*
* ```
*/
declare const SubMenu: BDSForwardRef;
declare type SubMenuRef = MenuRef;
interface SubMenuProps extends MenuProps {
/**
* Label to display in main menu for the sub menu
*/
label: string;
/**
* Menu Item Props to extend menu item with if needed
*/
menuItemProps?: React.PropsWithRef;
/**
* Menu Popover props
*/
menuPopoverProps?: React.PropsWithRef;
/**
* Whether or not submenu will listen to hover events
*/
listenHover?: MenuPopoverProps['listenHover'];
/**
* `onOpen` handler for popover
*/
onOpen?: MenuPopoverProps['onOpen'];
/**
* `onClose` handler for popover
*/
onClose?: MenuPopoverProps['onClose'];
/**
* Placement of the sub menu
*/
placement?: MenuPopoverProps['placement'];
}
export { SubMenu };
export type { SubMenuProps, SubMenuRef };
export default SubMenu;