@procore/core-react
Version:
React library of Procore Design Guidelines
28 lines (20 loc) • 1.33 kB
TypeScript
import React from 'react';
import type { PopoverContentProps, PopoverProps, PopoverRole } from './Popover.types';
declare function PopoverInner<Role extends PopoverRole>({ children, initialIsVisible, restoreFocusOnHide, placement, overlay, overlayRef, role, ...props }: PopoverProps<Role>, ref: React.ForwardedRef<HTMLElement>): React.JSX.Element;
/**
We use popovers to display more of an item’s information or details on hover.
This may be used to show additional fields in an item’s form that aren’t shown
by default in the UI. Oftentimes, there will be a visual queue to indicate that
more information is available.
Do not use popovers to display large amounts of information, perform data
entry, or use as a replacement for an overflow, menu, or modal.
If you want to show descriptive / educational information about an item,
use a tooltip.
@since 10.19.0
@see [Storybook](https://stories.core.procore.com/?path=/story/core-react_demos-popover--demo)
@see [Design Guidelines](https://design.procore.com/popover)
*/
export declare const Popover: (<Role extends PopoverRole>(props: PopoverProps<Role>) => ReturnType<typeof PopoverInner>) & {
Content: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLDivElement> & PopoverContentProps & React.RefAttributes<HTMLDivElement>>;
};
export {};