41 lines
1.3 KiB
Plaintext
41 lines
1.3 KiB
Plaintext
import { RefObject } from 'react';
|
|
import { AriaPopoverProps, AriaOverlayProps, PopoverAria } from '@react-aria/overlays';
|
|
import { OverlayPlacement } from '@heroui/aria-utils';
|
|
import { OverlayTriggerState } from '@react-stately/overlays';
|
|
|
|
interface Props {
|
|
/**
|
|
* Whether the element should render an arrow.
|
|
* @default false
|
|
*/
|
|
showArrow?: boolean;
|
|
/**
|
|
* The placement of the element with respect to its anchor element.
|
|
* @default 'top'
|
|
*/
|
|
placement?: OverlayPlacement;
|
|
/**
|
|
* A ref for the scrollable region within the overlay.
|
|
* @default popoverRef
|
|
*/
|
|
scrollRef?: RefObject<HTMLElement>;
|
|
/**
|
|
* List of dependencies to update the position of the popover.
|
|
* @default []
|
|
*/
|
|
updatePositionDeps?: any[];
|
|
/**
|
|
* Whether the popover should close on scroll.
|
|
* @default true
|
|
*/
|
|
shouldCloseOnScroll?: boolean;
|
|
}
|
|
type ReactAriaPopoverProps = Props & Omit<AriaPopoverProps, "placement"> & AriaOverlayProps;
|
|
/**
|
|
* Provides the behavior and accessibility implementation for a popover component.
|
|
* A popover is an overlay element positioned relative to a trigger.
|
|
*/
|
|
declare function useReactAriaPopover(props: ReactAriaPopoverProps, state: OverlayTriggerState): PopoverAria;
|
|
|
|
export { Props, ReactAriaPopoverProps, useReactAriaPopover };
|