TanTan
e311ca3275
Build NapCat Artifacts / Windows Loader Test (push) Canceled after 0s
Build NapCat Artifacts / Type Check & Test (push) Canceled after 0s
Build NapCat Artifacts / Build NapCat.Framework (push) Canceled after 0s
Build NapCat Artifacts / Build NapCat.Shell (push) Canceled after 0s
99 lines
3.9 KiB
Plaintext
99 lines
3.9 KiB
Plaintext
import * as React from 'react';
|
|
import { RefObject } from 'react';
|
|
import * as _heroui_system from '@heroui/system';
|
|
import { HTMLHeroUIProps, PropGetter } from '@heroui/system';
|
|
import { SlotsToClasses, PopoverSlots, PopoverVariantProps } from '@heroui/theme';
|
|
import { HTMLMotionProps } from 'framer-motion';
|
|
import { ReactRef } from '@heroui/react-utils';
|
|
import { OverlayTriggerState } from '@react-stately/overlays';
|
|
import { OverlayTriggerProps } from '@react-types/overlays';
|
|
import { AriaDialogProps } from '@react-aria/dialog';
|
|
import { ReactAriaPopoverProps } from './use-aria-popover.js';
|
|
import '@react-aria/overlays';
|
|
import '@heroui/aria-utils';
|
|
|
|
interface Props extends HTMLHeroUIProps<"div"> {
|
|
/**
|
|
* Ref to the DOM node.
|
|
*/
|
|
ref?: ReactRef<HTMLDivElement | null>;
|
|
/**
|
|
* The controlled state of the popover.
|
|
*/
|
|
state?: OverlayTriggerState;
|
|
/**
|
|
* The ref for the element which the overlay positions itself with respect to.
|
|
*/
|
|
triggerRef?: RefObject<HTMLElement>;
|
|
/**
|
|
* Whether the scroll event should be blocked when the overlay is open.
|
|
* @default true
|
|
*/
|
|
shouldBlockScroll?: boolean;
|
|
/**
|
|
* Custom props to be passed to the dialog container.
|
|
*
|
|
* @default {}
|
|
*/
|
|
dialogProps?: AriaDialogProps;
|
|
/**
|
|
* Type of overlay that is opened by the trigger.
|
|
*/
|
|
triggerType?: "dialog" | "menu" | "listbox" | "tree" | "grid";
|
|
/**
|
|
* The props to modify the framer motion animation. Use the `variants` API to create your own animation.
|
|
*/
|
|
motionProps?: HTMLMotionProps<"div">;
|
|
/**
|
|
* The container element in which the overlay portal will be placed.
|
|
* @default document.body
|
|
*/
|
|
portalContainer?: Element;
|
|
/**
|
|
* Classname or List of classes to change the classNames of the element.
|
|
* if `className` is passed, it will be added to the base slot.
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* <Popover classNames={{
|
|
* base:"base-classes",
|
|
* content: "content-classes",
|
|
* trigger: "trigger-classes",
|
|
* backdrop: "backdrop-classes",
|
|
* }} />
|
|
* ```
|
|
*/
|
|
classNames?: SlotsToClasses<PopoverSlots>;
|
|
/**
|
|
* Callback fired when the popover is closed.
|
|
*/
|
|
onClose?: () => void;
|
|
}
|
|
type UsePopoverProps = Props & Omit<ReactAriaPopoverProps, "triggerRef" | "popoverRef"> & OverlayTriggerProps & PopoverVariantProps;
|
|
declare function usePopover(originalProps: UsePopoverProps): {
|
|
state: OverlayTriggerState;
|
|
Component: _heroui_system.As<any>;
|
|
children: React.ReactNode;
|
|
classNames: SlotsToClasses<"base" | "content" | "trigger" | "backdrop" | "arrow"> | undefined;
|
|
showArrow: boolean;
|
|
triggerRef: RefObject<HTMLElement>;
|
|
placement: "center" | "top" | "bottom" | "left" | "right" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "left-start" | "left-end" | "right-start" | "right-end" | null;
|
|
isNonModal: boolean;
|
|
popoverRef: RefObject<HTMLDivElement>;
|
|
portalContainer: Element | undefined;
|
|
isOpen: boolean;
|
|
onClose: () => void;
|
|
disableAnimation: boolean;
|
|
shouldBlockScroll: boolean;
|
|
backdrop: "transparent" | "opaque" | "blur";
|
|
motionProps: HTMLMotionProps<"div"> | undefined;
|
|
getBackdropProps: PropGetter<Record<string, unknown>, _heroui_system.DOMAttributes<_heroui_system.DOMElement>>;
|
|
getPopoverProps: PropGetter<Record<string, unknown>, _heroui_system.DOMAttributes<_heroui_system.DOMElement>>;
|
|
getTriggerProps: PropGetter<Record<string, unknown>, _heroui_system.DOMAttributes<_heroui_system.DOMElement>>;
|
|
getDialogProps: PropGetter<Record<string, unknown>, _heroui_system.DOMAttributes<_heroui_system.DOMElement>>;
|
|
getContentProps: PropGetter<Record<string, unknown>, _heroui_system.DOMAttributes<_heroui_system.DOMElement>>;
|
|
};
|
|
type UsePopoverReturn = ReturnType<typeof usePopover>;
|
|
|
|
export { Props, UsePopoverProps, UsePopoverReturn, usePopover };
|