@cerberus-design/react
Version:
The Cerberus Design React component library.
126 lines (125 loc) • 4.29 kB
text/typescript
import { MenuContentProps, MenuTriggerProps } from './primitives';
import { ForwardRefExoticComponent, ReactNode, RefAttributes } from 'react';
import { BaseCerberusProps, CerberusPrimitiveProps } from '../..';
import { MenuRootProps, MenuItemProps, MenuItemGroupProps, MenuItemGroupLabelProps, MenuSeparatorProps } from '@ark-ui/react';
/**
* This module contains the Menu named abstractions component.
* @module @cerberus-design/react/components/menu
*/
/**
* The root Menu component which controls the menu.
* @definition [Cerberus docs](https://cerberus.digitalu.design/react/menu/dev)
*
* @example
* ```tsx
* <Menu>
* <MenuTrigger>Trigger</MenuTrigger>
* </Menu>
*/
export declare const Menu: ForwardRefExoticComponent< BaseCerberusProps & MenuRootProps & {
children?: ReactNode | undefined;
} & RefAttributes<unknown>>;
/**
* The MenuTrigger component opens/closes the Menu.
* @definition [Cerberus docs](https://cerberus.digitalu.design/react/menu/dev)
* @example
* ```tsx
* <Menu>
* <MenuTrigger>
* <Button>Trigger</Button>
* </MenuTrigger>
* </Menu>
*/
export declare function MenuTrigger(props: MenuTriggerProps): import("react/jsx-runtime").JSX.Element;
/**
* The MenuContent component is the container for the menu items.
* @definition [Cerberus docs](https://cerberus.digitalu.design/react/menu/dev)
* @example
* ```tsx
* <Menu>
* <MenuTrigger>
* <Button>Trigger</Button>
* </MenuTrigger>
* <MenuContent>
* <MenuItem value="item_1">Item 1</MenuItem>
* <MenuItem value="item_2">Item 2</MenuItem>
* </MenuContent>
* </Menu>
*/
export declare function MenuContent(props: MenuContentProps): import("react/jsx-runtime").JSX.Element;
/**
* The MenuItem component is a single item in the menu.
* @definition [Cerberus docs](https://cerberus.digitalu.design/react/menu/dev)
* @example
* ```tsx
* <Menu>
* <MenuTrigger>
* <Button>Trigger</Button>
* </MenuTrigger>
* <MenuContent>
* <MenuItem value="item_1">Item 1</MenuItem>
* <MenuItem value="item_2">Item 2</MenuItem>
* </MenuContent>
* </Menu>
*/
export declare const MenuItem: ForwardRefExoticComponent<Omit< CerberusPrimitiveProps< MenuItemProps & RefAttributes<HTMLDivElement>>, "ref"> & RefAttributes<unknown>>;
/**
* The MenuItemGroup component is a group of menu items.
* @definition [Cerberus docs](https://cerberus.digitalu.design/react/menu/dev)
* @example
* ```tsx
* <Menu>
* <MenuTrigger>
* <Button>Trigger</Button>
* </MenuTrigger>
* <MenuContent>
* <MenuItemGroup>
* <MenuItem value="item_1">Item 1</MenuItem>
* <MenuItem value="item_2">Item 2</MenuItem>
* </MenuItemGroup>
* </MenuContent>
* </Menu>
*/
export declare const MenuItemGroup: {
(props: CerberusPrimitiveProps< MenuItemGroupProps & RefAttributes<HTMLDivElement>>): import("react/jsx-runtime").JSX.Element;
displayName: string;
};
/**
* The MenuItemGroupLabel component is the label for a group of menu items.
* @definition [Cerberus docs](https://cerberus.digitalu.design/react/menu/dev)
* @example
* ```tsx
* <Menu>
* <MenuTrigger>
* <Button>Trigger</Button>
* </MenuTrigger>
* <MenuContent>
* <MenuItemGroup>
* <MenuItemGroupLabel>Group Label</MenuItemGroupLabel>
* <MenuItem value="item_1">Item 1</MenuItem>
* <MenuItem value="item_2">Item 2</MenuItem>
* </MenuItemGroup>
* </MenuContent>
* </Menu>
*/
export declare const MenuGroupLabel: ForwardRefExoticComponent<Omit< CerberusPrimitiveProps< MenuItemGroupLabelProps & RefAttributes<HTMLDivElement>>, "ref"> & RefAttributes<unknown>>;
/**
* The MenuSeparator component is a visual divider between menu items.
* @definition [Cerberus docs](https://cerberus.digitalu.design/react/menu/dev)
* @example
* ```tsx
* <Menu>
* <MenuTrigger>
* <Button>Trigger</Button>
* </MenuTrigger>
* <MenuContent>
* <MenuItemGroup>
* <MenuGroupLabel>Group Label</MenuGroupLabel>
* <MenuSeparator />
* <MenuItem value="item_1">Item 1</MenuItem>
* <MenuItem value="item_2">Item 2</MenuItem>
* </MenuItemGroup>
* </MenuContent>
* </Menu>
*/
export declare const MenuSeparator: ForwardRefExoticComponent<Omit< CerberusPrimitiveProps< MenuSeparatorProps & RefAttributes<HTMLHRElement>>, "ref"> & RefAttributes<unknown>>;