@base-ui-components/react
Version:
Base UI is a library of headless ('unstyled') React components and low-level hooks. You gain complete control over your app's CSS and accessibility features.
51 lines (50 loc) • 2.19 kB
TypeScript
import * as React from 'react';
import { type FloatingRootContext } from '@floating-ui/react';
import type { GenericHTMLProps } from '../../utils/types.js';
import type { TransitionStatus } from '../../utils/useTransitionStatus.js';
import { type OpenChangeReason } from '../../utils/translateOpenChangeReason.js';
export declare function usePreviewCardRoot(params: usePreviewCardRoot.Parameters): usePreviewCardRoot.ReturnValue;
export declare namespace usePreviewCardRoot {
interface Parameters {
/**
* Whether the preview card is initially open.
*
* To render a controlled preview card, use the `open` prop instead.
* @default false
*/
defaultOpen?: boolean;
/**
* Whether the preview card is currently open.
*/
open?: boolean;
/**
* Event handler called when the preview card is opened or closed.
*/
onOpenChange?: (open: boolean, event?: Event, reason?: OpenChangeReason) => void;
/**
* How long to wait before the preview card opens. Specified in milliseconds.
* @default 600
*/
delay?: number;
/**
* How long to wait before closing the preview card. Specified in milliseconds.
* @default 300
*/
closeDelay?: number;
}
interface ReturnValue {
open: boolean;
setOpen: (value: boolean, event?: Event, reason?: OpenChangeReason) => void;
mounted: boolean;
setMounted: React.Dispatch<React.SetStateAction<boolean>>;
getRootTriggerProps: (externalProps?: GenericHTMLProps) => GenericHTMLProps;
getRootPopupProps: (externalProps?: GenericHTMLProps) => GenericHTMLProps;
floatingRootContext: FloatingRootContext;
instantType: 'delay' | 'dismiss' | 'focus' | undefined;
transitionStatus: TransitionStatus;
setTriggerElement: React.Dispatch<React.SetStateAction<Element | null>>;
positionerElement: HTMLElement | null;
setPositionerElement: React.Dispatch<React.SetStateAction<HTMLElement | null>>;
popupRef: React.RefObject<HTMLDivElement | null>;
}
}