@sinchsmb/ui-kit
Version:
UI kit for SinchSMB frontend
27 lines (26 loc) • 769 B
TypeScript
import { ForwardedRef, ReactNode } from 'react';
import { CommonProps } from '../../types';
/** Props for {@link Menu} component */
export interface MenuProps extends CommonProps {
/** The element to be rendered as the trigger button */
trigger: ReactNode;
/** The ref of the trigger button */
triggerRef?: ForwardedRef<HTMLElement>;
/** If `true`, the menu will be disabled */
disabled?: boolean;
children: ReactNode;
}
/**
* Menu component
*
* ```tsx
* import { Menu, MenuTrigger } from '@ui-kit';
*
* <Menu trigger={<MenuTrigger>Menu</MenuTrigger>}>
* <MenuItem>Item 1</MenuItem>
* <MenuItem>Item 2</MenuItem>
* <MenuItem>Item 3</MenuItem>
* </Menu>
* ```
*/
export declare function Menu(props: MenuProps): JSX.Element;