UNPKG

@react-md/menu

Version:

Create menus that auto-position themselves within the viewport and adhere to the accessibility guidelines

36 lines (35 loc) 1.22 kB
import type { ReactElement } from "react"; import type { HoverableMenuBar } from "./MenuBarProvider"; import type { MenuBarWidgetProps } from "./MenuBarWidget"; /** @remarks \@since 5.0.0 */ export declare type MenuBarProps = MenuBarWidgetProps & HoverableMenuBar; /** * The `MenuBar` component is used to link child `DropdownGroup`s' visibility * together and following the specs for a * [menubar](https://www.w3.org/TR/wai-aria-practices/#menu). * * @example * Simple Example * ```tsx * import type { ReactElement } from "react"; * import { MenuBar, DropdownMenu, MenuItem } from "@react-md/menu"; * * function Example(): ReactElement { * return ( * <MenuBar aria-label="Example"> * <DropdownMenu id="menubar-item-1" buttonChildren="Item 1"> * <MenuItem>Sub-item 1</MenuItem> * <MenuItem>Sub-item 2</MenuItem> * </DropdownMenu> * <DropdownMenu id="menubar-item-2" buttonChildren="Item 2"> * <MenuItem>Sub-item 1</MenuItem> * <MenuItem>Sub-item 2</MenuItem> * </DropdownMenu> * </MenuBar> * ); * } * ``` * * @remarks \@since 5.0.0 */ export declare function MenuBar({ hoverTimeout, ...props }: MenuBarProps): ReactElement;