@primer/react
Version:
An implementation of GitHub's Primer Design System using React
41 lines (40 loc) • 1.79 kB
TypeScript
import React from 'react';
import { AnchoredOverlayProps } from '../AnchoredOverlay';
import { OverlayProps } from '../Overlay';
import { ButtonProps } from '../Button';
import { ForwardRefComponent as PolymorphicForwardRefComponent } from '../utils/polymorphic';
export type MenuContextProps = Pick<AnchoredOverlayProps, 'anchorRef' | 'renderAnchor' | 'open' | 'onOpen' | 'anchorId'> & {
onClose?: (gesture: 'anchor-click' | 'click-outside' | 'escape' | 'tab') => void;
};
export type ActionMenuProps = {
/**
* Recommended: `ActionMenu.Button` or `ActionMenu.Anchor` with `ActionMenu.Overlay`
*/
children: React.ReactElement[] | React.ReactElement;
/**
* If defined, will control the open/closed state of the overlay. Must be used in conjunction with `onOpenChange`.
*/
open?: boolean;
/**
* If defined, will control the open/closed state of the overlay. Must be used in conjunction with `open`.
*/
onOpenChange?: (s: boolean) => void;
} & Pick<AnchoredOverlayProps, 'anchorRef'>;
export type ActionMenuAnchorProps = {
children: React.ReactElement;
};
/** this component is syntactical sugar 🍭 */
export type ActionMenuButtonProps = ButtonProps;
type MenuOverlayProps = Partial<OverlayProps> & Pick<AnchoredOverlayProps, 'align'> & {
/**
* Recommended: `ActionList`
*/
children: React.ReactNode;
};
export declare const ActionMenu: React.FC<React.PropsWithChildren<ActionMenuProps>> & {
Button: PolymorphicForwardRefComponent<"button", ButtonProps>;
Anchor: React.ForwardRefExoticComponent<ActionMenuAnchorProps & React.RefAttributes<HTMLElement>>;
Overlay: React.FC<React.PropsWithChildren<MenuOverlayProps>>;
Divider: React.FC<React.PropsWithChildren<import("..").SxProp>>;
};
export {};